ghc/compiler/utils/StringBuffer.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1997
   3 %
   4 \section{String buffers}
   5
   6 Buffers for scanning string input stored in external arrays.
   7
   8 \begin{code}
   9
  10 {-# OPTIONS -fno-prune-tydecls #-}
  11 -- Don't really understand this!
  12 -- ERROR: Can't see the data constructor(s) for _ccall_/_casm_  argument;
  13 -- type: ForeignObj(try compiling with -fno-prune-tydecls ..)
  14
  15
  16 module StringBuffer
  17        (
  18         StringBuffer,
  19
  20          -- creation
  21         hGetStringBuffer,  -- :: FilePath       -> IO StringBuffer
  22         freeStringBuffer,  -- :: StringBuffer   -> IO ()
  23
  24          -- Lookup
  25         currentChar,      -- :: StringBuffer -> Char
  26         currentChar#,     -- :: StringBuffer -> Char#
  27         indexSBuffer,     -- :: StringBuffer -> Int -> Char
  28         indexSBuffer#,    -- :: StringBuffer -> Int# -> Char#
  29          -- relative lookup, i.e, currentChar = lookAhead 0
  30         lookAhead,        -- :: StringBuffer -> Int  -> Char
  31         lookAhead#,       -- :: StringBuffer -> Int# -> Char#
  32
  33          -- moving the end point of the current lexeme.
  34         setCurrentPos#,   -- :: StringBuffer -> Int# -> StringBuffer
  35         incLexeme,        -- :: StringBuffer -> StringBuffer
  36         decLexeme,        -- :: StringBuffer -> StringBuffer
  37
  38          -- move the start and end lexeme pointer on by x units.
  39         stepOn,           -- :: StringBuffer -> StringBuffer
  40         stepOnBy#,        -- :: StringBuffer -> Int# -> StringBuffer
  41         stepOnTo#,        -- :: StringBuffer -> Int# -> StringBuffer
  42         stepOnUntil,      -- :: (Char -> Bool) -> StringBuffer -> StringBuffer
  43         stepOverLexeme,   -- :: StringBuffer   -> StringBuffer
  44         scanNumLit,       -- :: Int -> StringBuffer -> (Int, StringBuffer)
  45         expandWhile,      -- :: (Char -> Bool) -> StringBuffer -> StringBuffer
  46         expandUntilMatch, -- :: StrinBuffer -> String -> StringBuffer
  47          -- at or beyond end of buffer?
  48         bufferExhausted,  -- :: StringBuffer -> Bool
  49         emptyLexeme,      -- :: StringBuffer -> Bool
  50
  51          -- matching
  52         prefixMatch,       -- :: StringBuffer -> String -> Bool
  53         untilEndOfString#, -- :: StringBuffer -> Int#
  54         untilEndOfChar#,   -- :: StringBuffer -> Int#
  55         untilChar#,        -- :: StringBuffer -> Char# -> Int#
  56
  57          -- conversion
  58         lexemeToString,     -- :: StringBuffer -> String
  59         lexemeToByteArray,  -- :: StringBuffer -> _ByteArray Int
  60         lexemeToFastString, -- :: StringBuffer -> FastString
  61         lexemeToBuffer,     -- :: StringBuffer -> StringBuffer
  62
  63         FastString,
  64         ByteArray
  65        ) where
  66
  67 #include "HsVersions.h"
  68
  69 import GlaExts
  70 import Addr             ( Addr(..) )
  71 import Foreign
  72 import ST
  73 import IO               ( openFile, hFileSize, hClose, IOMode(..) )
  74
  75 #if __GLASGOW_HASKELL__ < 301
  76 import IOBase           ( IOError(..), IOErrorType(..) )
  77 import IOHandle         ( readHandle, writeHandle, filePtr )
  78 import PackBase         ( unpackCStringBA )
  79 #else
  80 import PrelIOBase       ( IOError(..), IOErrorType(..) )
  81 import PrelHandle       ( readHandle, writeHandle, filePtr )
  82 import PrelPack         ( unpackCStringBA )
  83 #endif
  84
  85 import PrimPacked
  86 import FastString
  87 import Char             (isDigit)
  88 \end{code}
  89
  90 \begin{code}
  91 data StringBuffer
  92  = StringBuffer
  93      Addr#
  94 --     ForeignObj#  -- the data
  95      Int#         -- length
  96      Int#         -- lexeme start
  97      Int#         -- current pos
  98 \end{code}
  99
 100 \begin{code}
 101 instance Text StringBuffer where
 102         showsPrec _ s = showString ""
 103 \end{code}
 104
 105 \begin{code}
 106 hGetStringBuffer :: FilePath -> IO StringBuffer
 107 hGetStringBuffer fname =
 108 --    trace ("Renamer: opening " ++ fname) $
 109     openFile fname ReadMode >>= \ hndl ->
 110     hFileSize hndl          >>= \ len@(J# _ _ d#) ->
 111     let len_i = fromInteger len in
 112       -- Allocate an array for system call to store its bytes into.
 113       -- ToDo: make it robust
 114 --    trace (show ((len_i::Int)+1)) $
 115     _casm_ `` %r=(char *)malloc(sizeof(char)*(int)%0); '' (len_i::Int)  >>= \ arr@(A# a#) ->
 116     if addr2Int# a# ==# 0# then
 117        failWith MkIOError(hndl,UserError,("hGetStringBuffer: Could not allocate "++show len_i ++ " bytes"))
 118     else
 119
 120 --   _casm_ `` %r=NULL; ''                                   >>= \ free_p ->
 121 --    makeForeignObj arr free_p                              >>= \ fo@(_ForeignObj fo#) ->
 122      readHandle hndl        >>= \ hndl_ ->
 123      writeHandle hndl hndl_ >>
 124      let ptr = filePtr hndl_ in
 125      _ccall_ fread arr (1::Int) len_i ptr                     >>= \  (I# read#) ->
 126 --     trace ("DEBUG: opened " ++ fname ++ show (I# read#)) $
 127      hClose hndl                     >>
 128      if read# ==# 0# then -- EOF or other error
 129         failWith MkIOError(hndl,UserError,"hGetStringBuffer: EOF reached or some other error")
 130      else
 131         -- Add a sentinel NUL
 132         _casm_ `` ((char *)%0)[(int)%1]=(char)0; '' arr (I# (read# -# 1#)) >>= \ () ->
 133         return (StringBuffer a# read# 0# 0#)
 134
 135 freeStringBuffer :: StringBuffer -> IO ()
 136 freeStringBuffer (StringBuffer a# _ _ _) =
 137  _casm_ `` free((char *)%0); '' (A# a#)
 138
 139 unsafeWriteBuffer :: StringBuffer -> Int# -> Char# -> StringBuffer
 140 unsafeWriteBuffer s@(StringBuffer a _ _ _) i# ch# =
 141  unsafePerformIO (
 142    _casm_ `` ((char *)%0)[(int)%1]=(char)%2; '' (A# a) (I# i#) (C# ch#) >>= \ () ->
 143    return s
 144  )
 145
 146 \end{code}
 147
 148 Lookup
 149
 150 \begin{code}
 151 currentChar# :: StringBuffer -> Char#
 152 currentChar# (StringBuffer fo# _ _ current#) = indexCharOffAddr# fo# current#
 153
 154 currentChar  :: StringBuffer -> Char
 155 currentChar sb = case currentChar# sb of c -> C# c
 156
 157 indexSBuffer# :: StringBuffer -> Int# -> Char#
 158 indexSBuffer# (StringBuffer fo# _ _ _) i# = indexCharOffAddr# fo# i#
 159
 160 indexSBuffer :: StringBuffer -> Int -> Char
 161 indexSBuffer sb (I# i#) = case indexSBuffer# sb i# of c -> C# c
 162
 163  -- relative lookup, i.e, currentChar = lookAhead 0
 164 lookAhead# :: StringBuffer -> Int# -> Char#
 165 lookAhead# (StringBuffer fo# _ _ c#) i# = indexCharOffAddr# fo# (c# +# i#)
 166
 167 lookAhead :: StringBuffer -> Int  -> Char
 168 lookAhead sb (I# i#) = case lookAhead# sb i# of c -> C# c
 169
 170 \end{code}
 171
 172  moving the start point of the current lexeme.
 173
 174 \begin{code}
 175  -- moving the end point of the current lexeme.
 176 setCurrentPos# :: StringBuffer -> Int# -> StringBuffer
 177 setCurrentPos# (StringBuffer fo l# s# c#) i# =
 178  StringBuffer fo l# s# (c# +# i#)
 179
 180 -- augmenting the current lexeme by one.
 181 incLexeme :: StringBuffer -> StringBuffer
 182 incLexeme (StringBuffer fo l# s# c#) = StringBuffer fo l# s# (c# +# 1#)
 183
 184 decLexeme :: StringBuffer -> StringBuffer
 185 decLexeme (StringBuffer fo l# s# c#) = StringBuffer fo l# s# (c# -# 1#)
 186
 187 \end{code}
 188
 189 -- move the start and end point of the buffer on by
 190 -- x units.
 191
 192 \begin{code}
 193 stepOn :: StringBuffer -> StringBuffer
 194 stepOn (StringBuffer fo l# s# c#) = StringBuffer fo l# (s# +# 1#) (s# +# 1#) -- assume they're the same.
 195
 196 stepOnBy# :: StringBuffer -> Int# -> StringBuffer
 197 stepOnBy# (StringBuffer fo# l# s# c#) i# =
 198  case s# +# i# of
 199   new_s# -> StringBuffer fo# l# new_s# new_s#
 200
 201 -- jump to pos.
 202 stepOnTo# :: StringBuffer -> Int# -> StringBuffer
 203 stepOnTo# (StringBuffer fo l _ _) s# = StringBuffer fo l s# s#
 204
 205 stepOnUntil :: (Char -> Bool) -> StringBuffer -> StringBuffer
 206 stepOnUntil pred (StringBuffer fo l# s# c#) =
 207  loop c#
 208   where
 209    loop c# =
 210     case indexCharOffAddr# fo c# of
 211      ch# | pred (C# ch#) -> StringBuffer fo l# c# c#
 212          | ch# `eqChar#` '\NUL'# && c# >=# l# -> StringBuffer fo l# l# l# -- EOB, return immediately.
 213          | otherwise     -> loop (c# +# 1#)
 214
 215 stepOverLexeme :: StringBuffer -> StringBuffer
 216 stepOverLexeme (StringBuffer fo l s# c#) = StringBuffer fo l c# c#
 217
 218 expandWhile :: (Char -> Bool) -> StringBuffer -> StringBuffer
 219 expandWhile pred (StringBuffer fo l# s# c#) =
 220  loop c#
 221   where
 222    loop c# =
 223     case indexCharOffAddr# fo c# of
 224      ch# | pred (C# ch#) -> loop (c# +# 1#)
 225          | ch# `eqChar#` '\NUL'# && c# >=# l# -> StringBuffer fo l# l# l# -- EOB, return immediately.
 226          | otherwise     -> StringBuffer fo l# s# c#
 227
 228
 229 scanNumLit :: Int -> StringBuffer -> (Int,StringBuffer)
 230 scanNumLit (I# acc#) (StringBuffer fo l# s# c#) =
 231  loop acc# c#
 232   where
 233    loop acc# c# =
 234     case indexCharOffAddr# fo c# of
 235      ch# | isDigit (C# ch#) -> loop (acc# *# 10# +# (ord# ch# -# ord# '0'#)) (c# +# 1#)
 236          | ch# `eqChar#` '\NUL'# && c# >=# l# -> (I# acc#, StringBuffer fo l# l# l#) -- EOB, return immediately.
 237          | otherwise        -> (I# acc#,StringBuffer fo l# s# c#)
 238
 239
 240 expandUntilMatch :: StringBuffer -> String -> StringBuffer
 241 expandUntilMatch (StringBuffer fo l# s# c#) str =
 242   loop c# str
 243   where
 244    loop c# [] = StringBuffer fo l# s# c#
 245    loop c# ((C# x#):xs) =
 246      if indexCharOffAddr# fo c# `eqChar#` x# then
 247         loop (c# +# 1#) xs
 248      else
 249         loop (c# +# 1#) str
 250 \end{code}
 251
 252 \begin{code}
 253    -- at or beyond end of buffer?
 254 bufferExhausted :: StringBuffer -> Bool
 255 bufferExhausted (StringBuffer fo l# _ c#) = c# >=# l#
 256
 257 emptyLexeme :: StringBuffer -> Bool
 258 emptyLexeme (StringBuffer fo l# s# c#) = s# ==# c#
 259
 260  -- matching
 261 prefixMatch :: StringBuffer -> String -> Maybe StringBuffer
 262 prefixMatch (StringBuffer fo l# s# c#) str =
 263   loop c# str
 264   where
 265    loop c# [] = Just (StringBuffer fo l# s# c#)
 266    loop c# ((C# x#):xs) =
 267      if indexCharOffAddr# fo c# `eqChar#` x# then
 268         loop (c# +# 1#) xs
 269      else
 270         Nothing
 271
 272 untilEndOfString# :: StringBuffer -> StringBuffer
 273 untilEndOfString# (StringBuffer fo l# s# c#) =
 274  loop c#
 275  where
 276   loop c# =
 277    case indexCharOffAddr# fo c# of
 278     '\"'# ->
 279        case indexCharOffAddr# fo (c# -# 1#) of
 280         '\\'# ->
 281                   -- looks like an escaped something or other to me,
 282                   -- better count the number of "\\"s that are immediately
 283                   -- preceeding to decide if the " is escaped.
 284               let
 285                odd_slashes flg i# =
 286                 case indexCharOffAddr# fo i# of
 287                  '\\'# -> odd_slashes (not flg) (i# -# 1#)
 288                  _     -> flg
 289               in
 290               if odd_slashes True (c# -# 2#) then
 291                   -- odd number, " is ecaped.
 292                   loop (c# +# 1#)
 293               else  -- a real end of string delimiter after all.
 294                   StringBuffer fo l# s# c#
 295         _ -> StringBuffer fo l# s# c#
 296     '\NUL'# ->
 297         if c# >=# l# then -- hit sentinel, this doesn't look too good..
 298            StringBuffer fo l# l# l#
 299         else
 300            loop (c# +# 1#)
 301     _ -> loop (c# +# 1#)
 302
 303
 304 untilEndOfChar# :: StringBuffer -> StringBuffer
 305 untilEndOfChar# (StringBuffer fo l# s# c#) =
 306  loop c#
 307  where
 308   loop c# =
 309    case indexCharOffAddr# fo c# of
 310     '\''# ->
 311        case indexCharOffAddr# fo (c# -# 1#) of
 312         '\\'# ->
 313            case indexCharOffAddr# fo (c# -# 2#) of
 314              '\\'# -> -- end of char
 315                    StringBuffer fo l# s# c#
 316              _ -> loop (c# +# 1#) -- false alarm
 317         _ -> StringBuffer fo l# s# c#
 318     '\NUL'# ->
 319         if c# >=# l# then -- hit sentinel, this doesn't look too good..
 320            StringBuffer fo l# l# l#
 321         else
 322            loop (c# +# 1#)
 323     _ -> loop (c# +# 1#)
 324
 325 untilChar# :: StringBuffer -> Char# -> StringBuffer
 326 untilChar# (StringBuffer fo l# s# c#) x# =
 327  loop c#
 328  where
 329   loop c# =
 330    if indexCharOffAddr# fo c# `eqChar#` x# then
 331       StringBuffer fo l# s# c#
 332    else
 333       loop (c# +# 1#)
 334
 335          -- conversion
 336 lexemeToString :: StringBuffer -> String
 337 lexemeToString (StringBuffer fo _ start_pos# current#) =
 338  if start_pos# ==# current# then
 339     ""
 340  else
 341     unpackCStringBA (copySubStr (A# fo) (I# start_pos#) (I# (current# -# start_pos#)))
 342
 343 lexemeToByteArray :: StringBuffer -> _ByteArray Int
 344 lexemeToByteArray (StringBuffer fo _ start_pos# current#) =
 345  if start_pos# ==# current# then
 346     error "lexemeToByteArray"
 347  else
 348     copySubStr (A# fo) (I# start_pos#) (I# (current# -# start_pos#))
 349
 350 lexemeToFastString :: StringBuffer -> FastString
 351 lexemeToFastString (StringBuffer fo l# start_pos# current#) =
 352  if start_pos# ==# current# then
 353     mkFastCharString2 (A# fo) (I# 0#)
 354  else
 355     mkFastSubString (A# fo) (I# start_pos#) (I# (current# -# start_pos#))
 356
 357 {-
 358  Create a StringBuffer from the current lexeme, and add a sentinel
 359  at the end. Know What You're Doing before taking this function
 360  into use..
 361 -}
 362 lexemeToBuffer :: StringBuffer -> StringBuffer
 363 lexemeToBuffer (StringBuffer fo l# start_pos# current#) =
 364  if start_pos# ==# current# then
 365     StringBuffer fo 0# start_pos# current# -- an error, really.
 366  else
 367     unsafeWriteBuffer (StringBuffer fo (current# -# start_pos#) start_pos# start_pos#)
 368                       (current# -# 1#)
 369                       '\NUL'#
 370
 371 \end{code}