knob-0.1.1/0000755000000000000000000000000011740354346010637 5ustar0000000000000000knob-0.1.1/Setup.hs0000644000000000000000000000005611740354346012274 0ustar0000000000000000import Distribution.Simple main = defaultMain knob-0.1.1/license.txt0000644000000000000000000000204111740354346013017 0ustar0000000000000000Copyright (c) 2011 John Millikin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. knob-0.1.1/knob.cabal0000644000000000000000000000257111740354346012561 0ustar0000000000000000name: knob version: 0.1.1 license: MIT license-file: license.txt author: John Millikin maintainer: John Millikin build-type: Simple cabal-version: >= 1.6 category: System stability: experimental homepage: https://john-millikin.com/software/knob/ bug-reports: mailto:jmillikin@gmail.com synopsis: Memory-backed handles description: Create memory-backed 'Handle's, referencing virtual files. This is mostly useful for testing 'Handle'-based APIs without having to interact with the filesystem. . > import Data.ByteString (pack) > import Data.Knob > import System.IO > > main = do > knob <- newKnob (pack []) > h <- newFileHandle knob "test.txt" WriteMode > hPutStrLn h "Hello world!" > hClose h > bytes <- Data.Knob.getContents knob > putStrLn ("Wrote bytes: " ++ show bytes) extra-source-files: scripts/common.bash scripts/run-coverage scripts/run-tests -- tests/knob-tests.cabal tests/KnobTests.hs source-repository head type: bazaar location: https://john-millikin.com/software/knob/ source-repository this type: bazaar location: https://john-millikin.com/branches/knob/0.1/ tag: knob_0.1.1 library hs-source-dirs: lib ghc-options: -Wall -O2 build-depends: base >= 4.2 && < 5.0 , bytestring >= 0.9 , transformers >= 0.2 exposed-modules: Data.Knob knob-0.1.1/lib/0000755000000000000000000000000011740354346011405 5ustar0000000000000000knob-0.1.1/lib/Data/0000755000000000000000000000000011740354346012256 5ustar0000000000000000knob-0.1.1/lib/Data/Knob.hs0000644000000000000000000001502311740354346013504 0ustar0000000000000000{-# LANGUAGE DeriveDataTypeable #-} -- | -- Module: Data.Knob -- Copyright: 2011 John Millikin -- License: MIT -- -- Maintainer: jmillikin@gmail.com -- Portability: GHC only -- -- Create memory‐backed 'IO.Handle's, referencing virtual files. This is -- mostly useful for testing 'IO.Handle'‐based APIs without having to -- interact with the filesystem. -- -- > import Data.ByteString (pack) -- > import Data.Knob -- > import System.IO -- > -- > main = do -- > knob <- newKnob (pack []) -- > h <- newFileHandle knob "test.txt" WriteMode -- > hPutStrLn h "Hello world!" -- > hClose h -- > bytes <- Data.Knob.getContents knob -- > putStrLn ("Wrote bytes: " ++ show bytes) module Data.Knob ( Knob , newKnob , Data.Knob.getContents , setContents , newFileHandle , withFileHandle ) where import qualified Control.Concurrent.MVar as MVar import Control.Exception (bracket, throwIO) import Control.Monad (when) import Control.Monad.IO.Class (MonadIO, liftIO) import qualified Data.ByteString import Data.ByteString (ByteString) import Data.ByteString.Unsafe (unsafeUseAsCStringLen) import Data.Typeable (Typeable) import qualified Foreign import qualified GHC.IO.Buffer as IO import qualified GHC.IO.BufferedIO as IO import qualified GHC.IO.Device as IO import qualified GHC.IO.Exception as IO import qualified GHC.IO.Handle as IO import qualified System.IO as IO -- | A knob is a basic virtual file, which contains a byte buffer. A knob can -- have multiple 'IO.Handle's open to it, each of which behaves like a standard -- file handle. -- -- Use 'getContents' and 'setContents' to inspect and modify the knob’s -- byte buffer. newtype Knob = Knob (MVar.MVar ByteString) data Device = Device IO.IOMode (MVar.MVar ByteString) (MVar.MVar Int) deriving (Typeable) instance IO.IODevice Device where ready _ _ _ = return True close _ = return () isTerminal _ = return False isSeekable _ = return True seek (Device _ _ var) IO.AbsoluteSeek off = do checkOffset off MVar.modifyMVar_ var (\_ -> return (fromInteger off)) seek (Device _ _ var) IO.RelativeSeek off = do MVar.modifyMVar_ var (\old_off -> do let new_off = toInteger old_off + off checkOffset new_off return (fromInteger new_off)) seek dev@(Device _ _ off_var) IO.SeekFromEnd off = do MVar.modifyMVar_ off_var (\_ -> do size <- IO.getSize dev let new_off = size + off checkOffset new_off return (fromInteger new_off)) tell (Device _ _ var) = fmap toInteger (MVar.readMVar var) getSize (Device _ var _) = do bytes <- MVar.readMVar var return (toInteger (Data.ByteString.length bytes)) setSize dev size = setDeviceSize dev size devType _ = return IO.RegularFile checkOffset :: Integer -> IO () checkOffset off = when (toInteger (maxBound :: Int) < off) (throwIO err) where err = IO.IOError Nothing IO.InvalidArgument "" "offset > (maxBound :: Int)" Nothing Nothing setDeviceSize :: Device -> Integer -> IO () setDeviceSize (Device mode bytes_var _) size = checkSize >> setBytes where intSize :: Int intSize = fromInteger size checkSize = when (size > toInteger (maxBound :: Int)) $ do throwIO (IO.IOError Nothing IO.InvalidArgument "" "size > (maxBound :: Int)" Nothing Nothing) setBytes = MVar.modifyMVar_ bytes_var $ \bytes -> case mode of IO.ReadMode -> throwIO (IO.IOError Nothing IO.IllegalOperation "" "handle in ReadMode" Nothing Nothing) IO.WriteMode -> return (Data.ByteString.replicate intSize 0) IO.ReadWriteMode -> return (clip bytes) IO.AppendMode -> return (clip bytes) clip bytes = case intSize - Data.ByteString.length bytes of padLen | padLen > 0 -> Data.ByteString.append bytes (Data.ByteString.replicate padLen 0) _ -> Data.ByteString.take intSize bytes instance IO.BufferedIO Device where newBuffer _ = IO.newByteBuffer 4096 fillReadBuffer dev buf = do (numRead, newBuf) <- IO.fillReadBuffer0 dev buf return (maybe 0 id numRead, newBuf) fillReadBuffer0 (Device _ bytes_var pos_var) buf = do MVar.withMVar bytes_var $ \bytes -> do MVar.modifyMVar pos_var $ \pos -> do if pos >= Data.ByteString.length bytes then return (pos, (Nothing, buf)) else do let chunk = Data.ByteString.take (IO.bufSize buf) (Data.ByteString.drop pos bytes) unsafeUseAsCStringLen chunk $ \(chunkPtr, chunkLen) -> do Foreign.withForeignPtr (IO.bufRaw buf) $ \ptr -> do Foreign.copyArray ptr (Foreign.castPtr chunkPtr) chunkLen return (pos + chunkLen, (Just chunkLen, (buf { IO.bufL = 0, IO.bufR = chunkLen }))) flushWriteBuffer (Device _ bytes_var pos_var) buf = do MVar.modifyMVar_ bytes_var $ \bytes -> do MVar.modifyMVar pos_var $ \pos -> do let (before, after) = Data.ByteString.splitAt pos bytes let padding = Data.ByteString.replicate (pos - Data.ByteString.length before) 0 let bufStart ptr = Foreign.castPtr (Foreign.plusPtr ptr (IO.bufL buf)) let bufLen = IO.bufR buf - IO.bufL buf bufBytes <- Foreign.withForeignPtr (IO.bufRaw buf) (\ptr -> Data.ByteString.packCStringLen (bufStart ptr, bufLen)) let newBytes = Data.ByteString.concat [before, padding, bufBytes, Data.ByteString.drop bufLen after] return (pos + bufLen, newBytes) return (buf { IO.bufL = 0, IO.bufR = 0 }) flushWriteBuffer0 dev buf = do newBuf <- IO.flushWriteBuffer dev buf return (IO.bufR buf - IO.bufL buf, newBuf) newKnob :: MonadIO m => ByteString -> m Knob newKnob bytes = do var <- liftIO (MVar.newMVar bytes) return (Knob var) getContents :: MonadIO m => Knob -> m ByteString getContents (Knob var) = liftIO (MVar.readMVar var) setContents :: MonadIO m => Knob -> ByteString -> m () setContents (Knob var) bytes = liftIO (MVar.modifyMVar_ var (\_ -> return bytes)) -- | Create a new 'IO.Handle' pointing to a 'Knob'. This handle behaves like -- a file-backed handle for most purposes. newFileHandle :: MonadIO m => Knob -> String -- ^ Filename shown in error messages -> IO.IOMode -> m IO.Handle newFileHandle (Knob var) name mode = liftIO $ do startPosition <- MVar.withMVar var $ \bytes -> return $ case mode of IO.AppendMode -> Data.ByteString.length bytes _ -> 0 posVar <- MVar.newMVar startPosition IO.mkFileHandle (Device mode var posVar) name mode Nothing IO.noNewlineTranslation -- | See 'newFileHandle'. withFileHandle :: MonadIO m => Knob -> String -- ^ Filename shown in error messages. -> IO.IOMode -> (IO.Handle -> IO a) -> m a withFileHandle knob name mode io = liftIO (bracket (newFileHandle knob name mode) IO.hClose io) knob-0.1.1/tests/0000755000000000000000000000000011740354346012001 5ustar0000000000000000knob-0.1.1/tests/KnobTests.hs0000644000000000000000000002166311740354346014261 0ustar0000000000000000{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TemplateHaskell #-} -- Copyright (C) 2011 John Millikin -- -- See license.txt for details module Main ( tests , main ) where import Control.Monad.IO.Class (liftIO) import qualified Data.ByteString import Data.ByteString.Char8 () import Data.ByteString.Unsafe (unsafePackCStringLen) import Foreign (nullPtr) import qualified GHC.IO.Exception as GHC import System.IO import Test.Chell import Data.Knob main :: IO () main = Test.Chell.defaultMain tests tests :: [Suite] tests = [test_File, test_Duplex] test_File :: Suite test_File = suite "file" [ suite "read" [ test_ReadFromStart , test_ReadFromOffset , test_ReadToEOF , test_ReadPastEOF ] , suite "write" [ test_WriteFromStart , test_WriteFromOffset , test_WritePastEOF , test_WriteAppended ] , suite "seek" [ test_SeekAbsolute , test_SeekRelative , test_SeekFromEnd , test_SeekBeyondMaxInt ] , suite "setSize" [ test_SetSize_Read , test_SetSize_Write , test_SetSize_ReadWrite , test_SetSize_Append ] , test_Ready , test_Close , test_SetContents , test_WithFileHandle ] test_ReadFromStart :: Suite test_ReadFromStart = assertions "from-start" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode bytes <- liftIO $ Data.ByteString.hGet h 3 $expect (equal bytes "abc") off <- liftIO $ hTell h $expect (equal off 3) test_ReadFromOffset :: Suite test_ReadFromOffset = assertions "from-offset" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode liftIO $ hSeek h AbsoluteSeek 1 bytes <- liftIO $ Data.ByteString.hGet h 3 $expect (equal bytes "bcd") off <- liftIO $ hTell h $expect (equal off 4) test_ReadToEOF :: Suite test_ReadToEOF = assertions "to-eof" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode bytes <- liftIO $ Data.ByteString.hGet h 10 $expect (equal bytes "abcde") off <- liftIO $ hTell h $expect (equal off 5) test_ReadPastEOF :: Suite test_ReadPastEOF = assertions "past-eof" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode liftIO $ hSeek h AbsoluteSeek 10 bytes <- liftIO $ Data.ByteString.hGet h 10 $expect (equal bytes "") off <- liftIO $ hTell h $expect (equal off 10) test_WriteFromStart :: Suite test_WriteFromStart = assertions "from-start" $ do k <- newKnob "" h <- newFileHandle k "foo.txt" WriteMode liftIO $ hSetBuffering h NoBuffering liftIO $ Data.ByteString.hPut h "abcde" bytes <- Data.Knob.getContents k $expect (equal bytes "abcde") test_WriteFromOffset :: Suite test_WriteFromOffset = assertions "from-offset" $ do k <- newKnob "" h <- newFileHandle k "foo.txt" WriteMode liftIO $ hSetBuffering h NoBuffering liftIO $ Data.ByteString.hPut h "abcde" liftIO $ hSeek h AbsoluteSeek 2 liftIO $ Data.ByteString.hPut h "abcde" bytes <- Data.Knob.getContents k $expect (equal bytes "ababcde") test_WritePastEOF :: Suite test_WritePastEOF = assertions "past-eof" $ do k <- newKnob "" h <- newFileHandle k "foo.txt" WriteMode liftIO $ hSetBuffering h NoBuffering liftIO $ hSeek h AbsoluteSeek 2 liftIO $ Data.ByteString.hPut h "abcde" bytes <- Data.Knob.getContents k $expect (equal bytes "\0\0abcde") test_WriteAppended :: Suite test_WriteAppended = assertions "appended" $ do k <- newKnob "foo" h <- newFileHandle k "foo.txt" AppendMode liftIO $ hSetBuffering h NoBuffering liftIO $ Data.ByteString.hPut h "bar" bytes <- Data.Knob.getContents k $expect (equal bytes "foobar") test_SeekAbsolute :: Suite test_SeekAbsolute = assertions "absolute" $ do k <- newKnob "" h <- newFileHandle k "foo.txt" ReadMode before <- liftIO $ hTell h liftIO $ hSeek h AbsoluteSeek 2 after <- liftIO $ hTell h $expect (equal before 0) $expect (equal after 2) test_SeekRelative :: Suite test_SeekRelative = assertions "relative" $ do k <- newKnob "" h <- newFileHandle k "foo.txt" ReadMode before <- liftIO $ hTell h liftIO $ hSeek h RelativeSeek 2 after1 <- liftIO $ hTell h liftIO $ hSeek h RelativeSeek 2 after2 <- liftIO $ hTell h $expect (equal before 0) $expect (equal after1 2) $expect (equal after2 4) test_SeekFromEnd :: Suite test_SeekFromEnd = assertions "from-end" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode before <- liftIO $ hTell h liftIO $ hSeek h SeekFromEnd (- 2) after <- liftIO $ hTell h $expect (equal before 0) $expect (equal after 3) test_SeekBeyondMaxInt :: Suite test_SeekBeyondMaxInt = assertions "beyond-max-int" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode let intPlusOne = toInteger (maxBound :: Int) + 1 $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSeek" "offset > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSeek h AbsoluteSeek intPlusOne) $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSeek" "offset > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSeek h RelativeSeek intPlusOne) -- testing this with real contents is difficult/impossible on a -- 64-bit system, so use an unsafe function to corrupt the knob's -- internal buffer first. hugeBytes <- liftIO (unsafePackCStringLen (nullPtr, maxBound)) liftIO $ hSeek h AbsoluteSeek (intPlusOne - 1) setContents k hugeBytes $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSeek" "offset > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSeek h SeekFromEnd 2) test_Ready :: Suite test_Ready = assertions "ready" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode ready <- liftIO $ hReady h $expect ready _ <- liftIO $ Data.ByteString.hGet h 10 $expect $ throwsEq (GHC.IOError (Just h) GHC.EOF "hWaitForInput" "" Nothing (Just "foo.txt")) (hReady h) test_Close :: Suite test_Close = assertions "close" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode liftIO $ hClose h $expect $ throwsEq (GHC.IOError (Just h) GHC.IllegalOperation "hGetBuf" "handle is closed" Nothing (Just "foo.txt")) (Data.ByteString.hGet h 1) $expect $ throwsEq (GHC.IOError (Just h) GHC.IllegalOperation "hWaitForInput" "handle is closed" Nothing (Just "foo.txt")) (hReady h) test_SetSize_Read :: Suite test_SetSize_Read = assertions "ReadMode" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadMode let intPlusOne = toInteger (maxBound :: Int) + 1 $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSetFileSize" "size > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSetFileSize h intPlusOne) $expect $ throwsEq (GHC.IOError (Just h) GHC.IllegalOperation "hSetFileSize" "handle in ReadMode" Nothing (Just "foo.txt")) (hSetFileSize h 2) test_SetSize_Write :: Suite test_SetSize_Write = assertions "WriteMode" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" WriteMode let intPlusOne = toInteger (maxBound :: Int) + 1 $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSetFileSize" "size > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSetFileSize h intPlusOne) -- Resets contents to all NULL, regardless of offset liftIO $ hSeek h AbsoluteSeek 2 liftIO $ hSetFileSize h 4 bytes <- Data.Knob.getContents k $expect (equal bytes "\0\0\0\0") test_SetSize_ReadWrite :: Suite test_SetSize_ReadWrite = assertions "ReadWriteMode" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" ReadWriteMode let intPlusOne = toInteger (maxBound :: Int) + 1 $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSetFileSize" "size > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSetFileSize h intPlusOne) -- Truncates contents, regardless of offset do liftIO $ hSeek h AbsoluteSeek 2 liftIO $ hSetFileSize h 4 bytes <- Data.Knob.getContents k $expect (equal bytes "abcd") do liftIO $ hSetFileSize h 6 bytes <- Data.Knob.getContents k $expect (equal bytes "abcd\0\0") test_SetSize_Append :: Suite test_SetSize_Append = assertions "AppendMode" $ do k <- newKnob "abcde" h <- newFileHandle k "foo.txt" AppendMode let intPlusOne = toInteger (maxBound :: Int) + 1 $expect $ throwsEq (GHC.IOError (Just h) GHC.InvalidArgument "hSetFileSize" "size > (maxBound :: Int)" Nothing (Just "foo.txt")) (hSetFileSize h intPlusOne) do liftIO $ hSetFileSize h 4 bytes <- Data.Knob.getContents k $expect (equal bytes "abcd") do liftIO $ hSetFileSize h 6 bytes <- Data.Knob.getContents k $expect (equal bytes "abcd\0\0") test_SetContents :: Suite test_SetContents = assertions "setContents" $ do k <- newKnob "abcde" before <- Data.Knob.getContents k setContents k "foo" after <- Data.Knob.getContents k $expect (equal before "abcde") $expect (equal after "foo") test_WithFileHandle :: Suite test_WithFileHandle = assertions "withFileHandle" $ do k <- newKnob "" h <- withFileHandle k "test.txt" WriteMode $ \h -> do Data.ByteString.hPut h "abcde" return h bytes <- Data.Knob.getContents k $expect (equal bytes "abcde") closed <- liftIO $ hIsClosed h $expect closed test_Duplex :: Suite test_Duplex = suite "duplex" [] knob-0.1.1/tests/knob-tests.cabal0000644000000000000000000000061511740354346015060 0ustar0000000000000000name: knob-tests version: 0 build-type: Simple cabal-version: >= 1.6 flag coverage default: False manual: True executable knob_tests main-is: KnobTests.hs ghc-options: -Wall hs-source-dirs: ../lib,. if flag(coverage) ghc-options: -fhpc build-depends: base >= 4.2 && < 5.0 , bytestring >= 0.9 && < 0.10 , chell >= 0.2 && < 0.3 , transformers >= 0.2 && < 0.3 knob-0.1.1/scripts/0000755000000000000000000000000011740354346012326 5ustar0000000000000000knob-0.1.1/scripts/common.bash0000644000000000000000000000066211740354346014461 0ustar0000000000000000PATH="$PATH:$PWD/cabal-dev/bin/" VERSION=$(awk '/^version:/{print $2}' knob.cabal) CABAL_DEV=$(which cabal-dev) XZ=$(which xz) require_cabal_dev() { if [ -z "$CABAL_DEV" ]; then echo "Can't find 'cabal-dev' executable; make sure it exists on your "'$PATH' echo "Cowardly refusing to fuck with the global package database" exit 1 fi } clean_dev_install() { require_cabal_dev rm -rf dist $CABAL_DEV install || exit 1 } knob-0.1.1/scripts/run-coverage0000755000000000000000000000106311740354346014651 0ustar0000000000000000#!/bin/bash if [ ! -f 'knob.cabal' ]; then echo -n "Can't find knob.cabal; please run this script as" echo -n " ./scripts/run-coverage from within the knob source" echo " directory" exit 1 fi . scripts/common.bash require_cabal_dev pushd tests $CABAL_DEV -s ../cabal-dev install --flags="coverage" || exit 1 popd rm -f knob_tests.tix cabal-dev/bin/knob_tests $@ EXCLUDES="--exclude=Main" hpc markup --srcdir=src/ --srcdir=tests/ knob_tests.tix --destdir=hpc-markup $EXCLUDES > /dev/null hpc report --srcdir=src/ --srcdir=tests/ knob_tests.tix $EXCLUDES knob-0.1.1/scripts/run-tests0000755000000000000000000000054311740354346014222 0ustar0000000000000000#!/bin/bash if [ ! -f 'knob.cabal' ]; then echo -n "Can't find knob.cabal; please run this script as" echo -n " ./scripts/run-tests from within the knob source" echo " directory" exit 1 fi . scripts/common.bash require_cabal_dev clean_dev_install pushd tests rm -rf dist $CABAL_DEV -s ../cabal-dev install || exit 1 popd cabal-dev/bin/knob_tests