Safe Haskell	None
Language	Haskell2010

GHC.Data.FastString

Contents

ByteString
ShortByteString
FastZString
FastStrings
PtrStrings

Description

There are two principal string types used internally by GHC:

FastString

A compact, hash-consed, representation of character strings.
Comparison is O(1), and you can get a Unique from them.
Generated by fsLit.
Turn into SDoc with ftext.

PtrString

Pointer and size of a Latin-1 encoded string.
Practically no operations.
Outputting them is fast.
Generated by sLit.
Turn into SDoc with ptext
Requires manual memory management. Improper use may lead to memory leaks or dangling pointers.
It assumes Latin-1 as the encoding, therefore it cannot represent arbitrary Unicode strings.

Use PtrString unless you want the facilities of FastString.

Synopsis

bytesFS :: FastString -> ByteString
fastStringToByteString :: FastString -> ByteString
mkFastStringByteString :: ByteString -> FastString
fastZStringToByteString :: FastZString -> ByteString
unsafeMkByteString :: String -> ByteString
fastStringToShortByteString :: FastString -> ShortByteString
mkFastStringShortByteString :: ShortByteString -> FastString
data FastZString
hPutFZS :: Handle -> FastZString -> IO ()
zString :: FastZString -> String
lengthFZS :: FastZString -> Int
data FastString = FastString {
- uniq :: !Int
- n_chars :: !Int
- fs_sbs :: !ShortByteString
- fs_zenc :: FastZString
}
fsLit :: String -> FastString
mkFastString :: String -> FastString
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
mkFastStringByteList :: [Word8] -> FastString
mkFastString# :: Addr# -> FastString
unpackFS :: FastString -> String
zEncodeFS :: FastString -> FastZString
uniqueOfFS :: FastString -> Int
lengthFS :: FastString -> Int
nullFS :: FastString -> Bool
appendFS :: FastString -> FastString -> FastString
headFS :: FastString -> Char
concatFS :: [FastString] -> FastString
consFS :: Char -> FastString -> FastString
nilFS :: FastString
isUnderscoreFS :: FastString -> Bool
hPutFS :: Handle -> FastString -> IO ()
getFastStringTable :: IO [[[FastString]]]
getFastStringZEncCounter :: IO Int
data PtrString = PtrString !(Ptr Word8) !Int
sLit :: String -> PtrString
mkPtrString# :: Addr# -> PtrString
mkPtrString :: String -> PtrString
unpackPtrString :: PtrString -> String
lengthPS :: PtrString -> Int

ByteString

bytesFS :: FastString -> ByteString Source #

Gives the UTF-8 encoded bytes corresponding to a FastString

fastStringToByteString :: FastString -> ByteString Source #

Deprecated: Use bytesFS instead

Gives the UTF-8 encoded bytes corresponding to a FastString

mkFastStringByteString :: ByteString -> FastString Source #

Create a FastString by copying an existing ByteString

fastZStringToByteString :: FastZString -> ByteString Source #

unsafeMkByteString :: String -> ByteString Source #

ShortByteString

fastStringToShortByteString :: FastString -> ShortByteString Source #

mkFastStringShortByteString :: ShortByteString -> FastString Source #

Create a FastString from an existing ShortByteString without copying.

FastZString

data FastZString Source #

Instances

Instances details

NFData FastZString #
Instance details Defined in GHC.Data.FastString Methods rnf :: FastZString -> () Source #

hPutFZS :: Handle -> FastZString -> IO () Source #

zString :: FastZString -> String Source #

lengthFZS :: FastZString -> Int Source #

FastStrings

data FastString Source #

A FastString is a UTF-8 encoded string together with a unique ID. All FastStrings are stored in a global hashtable to support fast O(1) comparison.

It is also associated with a lazy reference to the Z-encoding of this string which is used by the compiler internally.

Constructors

FastString
Fields uniq :: !Int n_chars :: !Int fs_sbs :: !ShortByteString fs_zenc :: FastZString Lazily computed z-encoding of this string. Since `FastString`s are globally memoized this is computed at most once for any given string.

Instances

Instances details

Eq FastString #
Instance details Defined in GHC.Data.FastString Methods (==) :: FastString -> FastString -> Bool # (/=) :: FastString -> FastString -> Bool #
Data FastString #
Instance details Defined in GHC.Data.FastString Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FastString -> c FastString Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FastString Source # toConstr :: FastString -> Constr Source # dataTypeOf :: FastString -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FastString) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FastString) Source # gmapT :: (forall b. Data b => b -> b) -> FastString -> FastString Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FastString -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FastString -> r Source # gmapQ :: (forall d. Data d => d -> u) -> FastString -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> FastString -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source #
Ord FastString #
Instance details Defined in GHC.Data.FastString Methods compare :: FastString -> FastString -> Ordering # (<) :: FastString -> FastString -> Bool # (<=) :: FastString -> FastString -> Bool # (>) :: FastString -> FastString -> Bool # (>=) :: FastString -> FastString -> Bool # max :: FastString -> FastString -> FastString # min :: FastString -> FastString -> FastString #
Show FastString #
Instance details Defined in GHC.Data.FastString Methods showsPrec :: Int -> FastString -> ShowS Source # show :: FastString -> String Source # showList :: [FastString] -> ShowS Source #
IsString FastString #
Instance details Defined in GHC.Data.FastString Methods fromString :: String -> FastString Source #
Semigroup FastString #
Instance details Defined in GHC.Data.FastString Methods (<>) :: FastString -> FastString -> FastString Source # sconcat :: NonEmpty FastString -> FastString Source # stimes :: Integral b => b -> FastString -> FastString Source #
Monoid FastString #
Instance details Defined in GHC.Data.FastString Methods mempty :: FastString Source # mappend :: FastString -> FastString -> FastString Source # mconcat :: [FastString] -> FastString Source #
NFData FastString #
Instance details Defined in GHC.Data.FastString Methods rnf :: FastString -> () Source #
Outputable FastString #
Instance details Defined in GHC.Utils.Outputable Methods ppr :: FastString -> SDoc Source # pprPrec :: Rational -> FastString -> SDoc Source #
Uniquable FastString #
Instance details Defined in GHC.Types.Unique Methods getUnique :: FastString -> Unique Source #
Binary FastString #
Instance details Defined in GHC.Utils.Binary Methods put_ :: BinHandle -> FastString -> IO () Source # put :: BinHandle -> FastString -> IO (Bin FastString) Source # get :: BinHandle -> IO FastString Source #

Construction

fsLit :: String -> FastString Source #

mkFastString :: String -> FastString Source #

Creates a UTF-8 encoded FastString from a String

mkFastStringBytes :: Ptr Word8 -> Int -> FastString Source #

mkFastStringByteList :: [Word8] -> FastString Source #

Creates a FastString from a UTF-8 encoded [Word8]

mkFastString# :: Addr# -> FastString Source #

Deconstruction

unpackFS :: FastString -> String Source #

Unpacks and decodes the FastString

Encoding

zEncodeFS :: FastString -> FastZString Source #

Returns a Z-encoded version of a FastString. This might be the original, if it was already Z-encoded. The first time this function is applied to a particular FastString, the results are memoized.

Operations

uniqueOfFS :: FastString -> Int Source #

lengthFS :: FastString -> Int Source #

Returns the length of the FastString in characters

nullFS :: FastString -> Bool Source #

Returns True if the FastString is empty

appendFS :: FastString -> FastString -> FastString Source #

headFS :: FastString -> Char Source #

concatFS :: [FastString] -> FastString Source #

consFS :: Char -> FastString -> FastString Source #

nilFS :: FastString Source #

isUnderscoreFS :: FastString -> Bool Source #

Outputting

hPutFS :: Handle -> FastString -> IO () Source #

Outputs a FastString with no decoding at all, that is, you get the actual bytes in the FastString written to the Handle.

Internal

getFastStringTable :: IO [[[FastString]]] Source #

getFastStringZEncCounter :: IO Int Source #

PtrStrings

data PtrString Source #

A PtrString is a pointer to some array of Latin-1 encoded chars.

Constructors

PtrString !(Ptr Word8) !Int

Construction

sLit :: String -> PtrString Source #

mkPtrString# :: Addr# -> PtrString Source #

Wrap an unboxed address into a PtrString.

mkPtrString :: String -> PtrString Source #

Encode a String into a newly allocated PtrString using Latin-1 encoding. The original string must not contain non-Latin-1 characters (above codepoint 0xff).

Deconstruction

unpackPtrString :: PtrString -> String Source #

Decode a PtrString back into a String using Latin-1 encoding. This does not free the memory associated with PtrString.

Operations

lengthPS :: PtrString -> Int Source #

Return the length of a PtrString