Copyright	(c) 2009 Bernie Pope
License	BSD-style
Maintainer	bjpop@csse.unimelb.edu.au
Stability	experimental
Portability	ghc
Safe Haskell	Safe
Language	Haskell2010

Language.Python.Common.SrcLocation

Contents

Construction
Modification
Projection of components of a span

Description

Source location information for the Python lexer and parser. This module provides single-point locations and spans, and conversions between them.

Synopsis

data SrcLocation
- = Sloc {
  - sloc_filename :: !String
  - sloc_row :: !Int
  - sloc_column :: !Int
  }
- | NoLocation
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
class Span a where
- getSpan :: a -> SrcSpan
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 sloc_filename :: !String sloc_row :: !Int sloc_column :: !Int
NoLocation

Instances

Eq SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods (==) :: SrcLocation -> SrcLocation -> Bool # (/=) :: SrcLocation -> SrcLocation -> Bool #
Data SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcLocation -> c SrcLocation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcLocation # toConstr :: SrcLocation -> Constr # dataTypeOf :: SrcLocation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SrcLocation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcLocation) # gmapT :: (forall b. Data b => b -> b) -> SrcLocation -> SrcLocation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcLocation -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcLocation -> r # gmapQ :: (forall d. Data d => d -> u) -> SrcLocation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcLocation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcLocation -> m SrcLocation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcLocation -> m SrcLocation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcLocation -> m SrcLocation #
Ord SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods compare :: SrcLocation -> SrcLocation -> Ordering # (<) :: SrcLocation -> SrcLocation -> Bool # (<=) :: SrcLocation -> SrcLocation -> Bool # (>) :: SrcLocation -> SrcLocation -> Bool # (>=) :: SrcLocation -> SrcLocation -> Bool # max :: SrcLocation -> SrcLocation -> SrcLocation # min :: SrcLocation -> SrcLocation -> SrcLocation #
Show SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods showsPrec :: Int -> SrcLocation -> ShowS # show :: SrcLocation -> String # showList :: [SrcLocation] -> ShowS #
Pretty SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods pretty :: SrcLocation -> Doc Source #
Span SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: SrcLocation -> SrcSpan Source #

data SrcSpan Source #

Source location spanning a contiguous section of a file.

Constructors

SpanCoLinear	A span which starts and ends on the same line.
Fields span_filename :: !String span_row :: !Int span_start_column :: !Int span_end_column :: !Int
SpanMultiLine	A span which starts and ends on different lines.
Fields span_filename :: !String span_start_row :: !Int span_start_column :: !Int span_end_row :: !Int span_end_column :: !Int
SpanPoint	A span which is actually just one point in the file.
Fields span_filename :: !String span_row :: !Int span_column :: !Int
SpanEmpty	No span information.

Instances

Eq SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods (==) :: SrcSpan -> SrcSpan -> Bool # (/=) :: SrcSpan -> SrcSpan -> Bool #
Data SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcSpan -> c SrcSpan # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcSpan # toConstr :: SrcSpan -> Constr # dataTypeOf :: SrcSpan -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SrcSpan) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcSpan) # gmapT :: (forall b. Data b => b -> b) -> SrcSpan -> SrcSpan # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r # gmapQ :: (forall d. Data d => d -> u) -> SrcSpan -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcSpan -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan #
Ord SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods compare :: SrcSpan -> SrcSpan -> Ordering # (<) :: SrcSpan -> SrcSpan -> Bool # (<=) :: SrcSpan -> SrcSpan -> Bool # (>) :: SrcSpan -> SrcSpan -> Bool # (>=) :: SrcSpan -> SrcSpan -> Bool # max :: SrcSpan -> SrcSpan -> SrcSpan # min :: SrcSpan -> SrcSpan -> SrcSpan #
Show SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods showsPrec :: Int -> SrcSpan -> ShowS # show :: SrcSpan -> String # showList :: [SrcSpan] -> ShowS #
Pretty SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods pretty :: SrcSpan -> Doc Source #
Span SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: SrcSpan -> SrcSpan Source #
Span AssignOpSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: AssignOpSpan -> SrcSpan Source #
Span OpSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: OpSpan -> SrcSpan Source #
Span SliceSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: SliceSpan -> SrcSpan Source #
Span DictKeyDatumListSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: DictKeyDatumListSpan -> SrcSpan Source #
Span YieldArgSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: YieldArgSpan -> SrcSpan Source #
Span ExprSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ExprSpan -> SrcSpan Source #
Span CompIterSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompIterSpan -> SrcSpan Source #
Span CompIfSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompIfSpan -> SrcSpan Source #
Span CompForSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompForSpan -> SrcSpan Source #
Span ComprehensionExprSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ComprehensionExprSpan -> SrcSpan Source #
Span ComprehensionSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ComprehensionSpan -> SrcSpan Source #
Span ExceptClauseSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ExceptClauseSpan -> SrcSpan Source #
Span HandlerSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: HandlerSpan -> SrcSpan Source #
Span ArgumentSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ArgumentSpan -> SrcSpan Source #
Span ParamTupleSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ParamTupleSpan -> SrcSpan Source #
Span ParameterSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ParameterSpan -> SrcSpan Source #
Span DecoratorSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: DecoratorSpan -> SrcSpan Source #
Span StatementSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: StatementSpan -> SrcSpan Source #
Span ImportRelativeSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ImportRelativeSpan -> SrcSpan Source #
Span FromItemsSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: FromItemsSpan -> SrcSpan Source #
Span FromItemSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: FromItemSpan -> SrcSpan Source #
Span ImportItemSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ImportItemSpan -> SrcSpan Source #
Span IdentSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: IdentSpan -> SrcSpan Source #

class Span a where Source #

Types which have a span.

Minimal complete definition

Nothing

Methods

getSpan :: a -> SrcSpan Source #

Instances

Span SrcSpan Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: SrcSpan -> SrcSpan Source #
Span SrcLocation Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: SrcLocation -> SrcSpan Source #
Span AssignOpSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: AssignOpSpan -> SrcSpan Source #
Span OpSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: OpSpan -> SrcSpan Source #
Span SliceSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: SliceSpan -> SrcSpan Source #
Span DictKeyDatumListSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: DictKeyDatumListSpan -> SrcSpan Source #
Span YieldArgSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: YieldArgSpan -> SrcSpan Source #
Span ExprSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ExprSpan -> SrcSpan Source #
Span CompIterSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompIterSpan -> SrcSpan Source #
Span CompIfSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompIfSpan -> SrcSpan Source #
Span CompForSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: CompForSpan -> SrcSpan Source #
Span ComprehensionExprSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ComprehensionExprSpan -> SrcSpan Source #
Span ComprehensionSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ComprehensionSpan -> SrcSpan Source #
Span ExceptClauseSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ExceptClauseSpan -> SrcSpan Source #
Span HandlerSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: HandlerSpan -> SrcSpan Source #
Span ArgumentSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ArgumentSpan -> SrcSpan Source #
Span ParamTupleSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ParamTupleSpan -> SrcSpan Source #
Span ParameterSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ParameterSpan -> SrcSpan Source #
Span DecoratorSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: DecoratorSpan -> SrcSpan Source #
Span StatementSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: StatementSpan -> SrcSpan Source #
Span ImportRelativeSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ImportRelativeSpan -> SrcSpan Source #
Span FromItemsSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: FromItemsSpan -> SrcSpan Source #
Span FromItemSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: FromItemSpan -> SrcSpan Source #
Span ImportItemSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: ImportItemSpan -> SrcSpan Source #
Span IdentSpan Source #
Instance details Defined in Language.Python.Common.AST Methods getSpan :: IdentSpan -> SrcSpan Source #
Span Token Source #
Instance details Defined in Language.Python.Common.Token Methods getSpan :: Token -> SrcSpan Source #
Span a => Span [a] Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: [a] -> SrcSpan Source #
Span a => Span (Maybe a) Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: Maybe a -> SrcSpan Source #
(Span a, Span b) => Span (Either a b) Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: Either a b -> SrcSpan Source #
(Span a, Span b) => Span (a, b) Source #
Instance details Defined in Language.Python.Common.SrcLocation Methods getSpan :: (a, b) -> SrcSpan Source #