-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Types and functionality for working with source code
--   
--   Types and functionality for working with source code (program text).
@package semantic-source
@version 0.0.1.0

module Source.Range

-- | A 0-indexed, half-open interval of integers, defined by start &
--   end indices.
data Range
Range :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Range
[start] :: Range -> {-# UNPACK #-} !Int
[end] :: Range -> {-# UNPACK #-} !Int

-- | Construct a <a>Range</a> with a given value for both its start and end
--   indices.
point :: Int -> Range

-- | Return the length of the range.
rangeLength :: Range -> Int
subtractRange :: Range -> Range -> Range
start_ :: Lens' Range Int
end_ :: Lens' Range Int
instance GHC.Show.Show Source.Range.Range
instance GHC.Classes.Ord Source.Range.Range
instance GHC.Generics.Generic Source.Range.Range
instance GHC.Classes.Eq Source.Range.Range
instance Data.Hashable.Class.Hashable Source.Range.Range
instance Control.DeepSeq.NFData Source.Range.Range
instance GHC.Base.Semigroup Source.Range.Range
instance Data.Semilattice.Lower.Lower Source.Range.Range


-- | Source position and span information
--   
--   Mostly taken from purescript's SourcePos definition.
module Source.Span

-- | A Span of position information
data Span
Span :: {-# UNPACK #-} !Pos -> {-# UNPACK #-} !Pos -> Span
[start] :: Span -> {-# UNPACK #-} !Pos
[end] :: Span -> {-# UNPACK #-} !Pos

-- | Construct a Span with a given value for both its start and end
--   positions.
point :: Pos -> Span
spanFromSrcLoc :: SrcLoc -> Span

-- | Source position information (1-indexed)
data Pos
Pos :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Pos
[line] :: Pos -> {-# UNPACK #-} !Int
[column] :: Pos -> {-# UNPACK #-} !Int
line_ :: Lens' Pos Int
column_ :: Lens' Pos Int

-- | "Classy-fields" interface for data types that have spans.
class HasSpan a
span_ :: HasSpan a => Lens' a Span
start_ :: HasSpan a => Lens' a Pos
end_ :: HasSpan a => Lens' a Pos
instance GHC.Show.Show Source.Span.Span
instance GHC.Generics.Generic Source.Span.Span
instance GHC.Classes.Ord Source.Span.Span
instance GHC.Classes.Eq Source.Span.Span
instance GHC.Show.Show Source.Span.Pos
instance GHC.Generics.Generic Source.Span.Pos
instance GHC.Classes.Ord Source.Span.Pos
instance GHC.Classes.Eq Source.Span.Pos
instance Source.Span.HasSpan Source.Span.Span
instance Data.Hashable.Class.Hashable Source.Span.Span
instance Control.DeepSeq.NFData Source.Span.Span
instance GHC.Base.Semigroup Source.Span.Span
instance Data.Aeson.Types.ToJSON.ToJSON Source.Span.Span
instance Data.Aeson.Types.FromJSON.FromJSON Source.Span.Span
instance Data.Semilattice.Lower.Lower Source.Span.Span
instance Data.Hashable.Class.Hashable Source.Span.Pos
instance Control.DeepSeq.NFData Source.Span.Pos
instance Data.Aeson.Types.ToJSON.ToJSON Source.Span.Pos
instance Data.Aeson.Types.FromJSON.FromJSON Source.Span.Pos
instance Data.Semilattice.Lower.Lower Source.Span.Pos


-- | <a>Source</a> models source code, represented as a thin wrapper around
--   a <a>ByteString</a> with conveniences for splitting by line, slicing,
--   etc.
--   
--   This module is intended to be imported qualified to avoid name clashes
--   with <tt>Prelude</tt>:
--   
--   <pre>
--   import qualified Source.Source as Source
--   </pre>
module Source.Source

-- | The contents of a source file. This is represented as a UTF-8
--   <tt>ByteString</tt> under the hood. Construct these with
--   <a>fromUTF8</a>; obviously, passing <a>fromUTF8</a> non-UTF8 bytes
--   will cause crashes.
data Source
bytes :: Source -> ByteString
fromUTF8 :: ByteString -> Source
length :: Source -> Int
null :: Source -> Bool

-- | Return a <a>Range</a> that covers the entire text.
totalRange :: Source -> Range

-- | Return a <a>Span</a> that covers the entire text.
totalSpan :: Source -> Span

-- | Return a <a>Source</a> from a <tt>Text</tt>.
fromText :: Text -> Source

-- | Return the Text contained in the <a>Source</a>.
toText :: Source -> Text

-- | Return a <a>Source</a> that contains a slice of the given
--   <a>Source</a>.
slice :: Source -> Range -> Source
drop :: Int -> Source -> Source
take :: Int -> Source -> Source

-- | Split the contents of the source after newlines.
lines :: Source -> [Source]

-- | Compute the <a>Range</a>s of each line in a <a>Source</a>.
lineRanges :: Source -> [Range]

-- | Compute the <a>Range</a>s of each line in a <a>Range</a> of a
--   <a>Source</a>.
lineRangesWithin :: Source -> Range -> [Range]

-- | Return all indices of newlines ('n', 'r', and 'rn') in the
--   <tt>ByteString</tt>.
newlineIndices :: ByteString -> [Int]
instance Control.DeepSeq.NFData Source.Source.Source
instance GHC.Generics.Generic Source.Source.Source
instance GHC.Show.Show Source.Source.Source
instance Data.String.IsString Source.Source.Source
instance GHC.Base.Monoid Source.Source.Source
instance GHC.Base.Semigroup Source.Source.Source
instance GHC.Classes.Eq Source.Source.Source
instance Data.Aeson.Types.FromJSON.FromJSON Source.Source.Source

module Source.Loc
data Loc
Loc :: {-# UNPACK #-} !Range -> {-# UNPACK #-} !Span -> Loc
[byteRange] :: Loc -> {-# UNPACK #-} !Range
[span] :: Loc -> {-# UNPACK #-} !Span
byteRange_ :: Lens' Loc Range

-- | A Span of position information
data Span
Span :: {-# UNPACK #-} !Pos -> {-# UNPACK #-} !Pos -> Span

-- | A 0-indexed, half-open interval of integers, defined by start &amp;
--   end indices.
data Range
Range :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Range
instance GHC.Base.Semigroup Source.Loc.Loc
instance GHC.Generics.Generic Source.Loc.Loc
instance GHC.Show.Show Source.Loc.Loc
instance GHC.Classes.Ord Source.Loc.Loc
instance GHC.Classes.Eq Source.Loc.Loc
instance Data.Hashable.Class.Hashable Source.Loc.Loc
instance Control.DeepSeq.NFData Source.Loc.Loc
instance Source.Span.HasSpan Source.Loc.Loc