2957f7b · vty · git.iko.soy

git.iko.soy/vty

update docs and change unsafeIOToST import

commit2957f7b6e1c43338803ab00ea6592aedf880ca78 authorCorey O'Connor <corey@ooyala.com> dateMon 24 Dec 2012, 21:44 (14 years ago) parentae0f2ba

4 files changed+16−13

compare with master

unifiedsplit

src/Codec/Binary/UTF8/Debug.hs+1−1 src/Codec/Binary/UTF8/Width.hs−6 src/Data/Terminfo/Eval.hs+1 src/Graphics/Vty/Span.hs+14−6

src/Codec/Binary/UTF8/Debug.hs+1−1

@@ -8,7 +8,7 @@ import Data.Word

99import Numeric

1010

11−-- Converts an array of ISO-10646 characters (Char type) to an array of Word8 bytes that is the

11+-- | Converts an array of ISO-10646 characters (Char type) to an array of Word8 bytes that is the

1212-- corresponding UTF8 byte sequence

1313utf8_from_iso :: Integral i => [i] -> [Word8]

1414utf8_from_iso = encode . map toEnum

src/Codec/Binary/UTF8/Width.hs−6

@@ -11,16 +11,12 @@ import Foreign.C.String

1111import Foreign.Storable

1212import Foreign.Ptr

1313

14−-- import Numeric ( showHex )

15−

1614import System.IO.Unsafe

1715

1816wcwidth :: Char -> Int

1917wcwidth c = unsafePerformIO (withCWString [c] $! \ws -> do

2018 wc <- peek ws

21− -- putStr $ "wcwidth(0x" ++ showHex (fromEnum wc) "" ++ ")"

2219 let !w = fromIntegral $! wcwidth' wc

23− -- putStrLn $ " -> " ++ show w

2420 return w

2521 )

2622{-# NOINLINE wcwidth #-}

@@ -29,9 +25,7 @@ foreign import ccall unsafe "vty_mk_wcwidth" wcwidth' :: CWchar -> CInt

2925

3026wcswidth :: String -> Int

3127wcswidth str = unsafePerformIO (withCWStringLen str $! \(ws, ws_len) -> do

32− -- putStr $ "wcswidth(...)"

3328 let !w = fromIntegral $! wcswidth' ws (fromIntegral ws_len)

34− -- putStrLn $ " -> " ++ show w

3529 return w

3630 )

3731{-# NOINLINE wcswidth #-}

src/Data/Terminfo/Eval.hs+1

@@ -28,6 +28,7 @@ import Data.List

2828import GHC.Prim

2929import GHC.Word

3030

31+-- | capability evaluator state

3132data EvalState = EvalState

3233 { eval_stack :: ![ CapParam ]

3334 , eval_expression :: !CapExpression

src/Graphics/Vty/Span.hs+14−6

@@ -16,7 +16,8 @@ import Graphics.Vty.DisplayRegion

1616import Codec.Binary.UTF8.String ( encode )

1717

1818import Control.Monad ( forM_ )

19−import Control.Monad.ST.Strict

19+import Control.Monad.ST.Strict hiding ( unsafeIOToST )

20+import Control.Monad.ST.Unsafe ( unsafeIOToST )

2021

2122import Data.Vector (Vector)

2223import qualified Data.Vector as Vector hiding ( take, replicate )

@@ -48,12 +49,15 @@ data DisplayOps = DisplayOps

4849 , display_ops :: RowOps

4950 }

5051

51−-- vector of span operation vectors. One per row of the screen.

52+-- | vector of span operation vectors. One per row of the screen.

5253type RowOps = Vector SpanOps

5354

5455type MRowOps s = MVector s SpanOps

5556

56−-- vector of span operations. executed in succession

57+-- | vector of span operations. executed in succession. This represents the operations required to

58+-- render a row of the terminal. The operations in one row may effect subsequent rows.

59+-- EG: Setting the foreground color in one row will effect all subsequent rows until the foreground

60+-- color is changed.

5761type SpanOps = Vector SpanOp

5862

5963type MSpanOps s = MVector s SpanOp

@@ -66,19 +70,23 @@ instance Show SpanOp where

6670 show (AttributeChange attr) = show attr

6771 show (TextSpan ow cw _) = "TextSpan " ++ show ow ++ " " ++ show cw

6872

73+-- | Number of columns the DisplayOps are defined for

6974span_ops_columns :: DisplayOps -> Word

7075span_ops_columns ops = region_width $ effected_region ops

7176

77+-- | Number of rows the DisplayOps are defined for

7278span_ops_rows :: DisplayOps -> Word

7379span_ops_rows ops = region_height $ effected_region ops

7480

81+-- | The number of columns a SpanOps effects.

7582span_ops_effected_columns :: SpanOps -> Word

7683span_ops_effected_columns in_ops = Vector.foldl' span_ops_effected_columns' 0 in_ops

7784 where

7885 span_ops_effected_columns' t (TextSpan w _ _ ) = t + w

7986 span_ops_effected_columns' t _ = t

8087

81−-- |

88+-- | This represents an operation on the terminal. Either an attribute change or the output of a

89+-- text string.

8290--

8391-- todo: This type may need to be restructured to increase sharing in the bytestring

8492--

@@ -91,12 +99,12 @@ data SpanOp =

9199 | TextSpan !Word !Word (UTF8.UTF8 B.ByteString)

92100 deriving Eq

93101

94−-- used to determine the width of a span operation , if it has one.

102+-- | The width of a single SpanOp in columns

95103span_op_has_width :: SpanOp -> Maybe (Word, Word)

96104span_op_has_width (TextSpan ow cw _) = Just (cw, ow)

97105span_op_has_width _ = Nothing

98106

99−-- returns the number of columns to the character at the given position in the span op

107+-- | returns the number of columns to the character at the given position in the span op

100108columns_to_char_offset :: Word -> SpanOp -> Word

101109columns_to_char_offset cx (TextSpan _ _ utf8_str) =

102110 let str = UTF8.toString utf8_str