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


-- | Minimalistic console UI (getLine), arrow key support (edit, browse cmd history).
--   
--   The UI library provides a more modern getLine style function for
--   making console based CLIs (command line interfaces). The library
--   provides editing capabilities through the use of arrow keys, as well
--   as browsing through the command history. It is very minimalistic, does
--   only export two functions and doesn't require its own monad (only IO).
@package ui
@version 1.0.0


-- | The <b>UI library</b> provides a more modern <i>getLine</i> style
--   function for making console based CLIs (command line interfaces). The
--   library provides editing capabilities through the use of arrow keys,
--   as well as browsing through the command history.
--   
--   It is very minimalistic, does only export two functions and doesn't
--   require its own monad (only IO).
module Data.UI

-- | Term is the internal state of the library.
data Term
Term :: Bool -> Vector Line -> Int -> Int -> Line -> Int -> Int -> Line -> Term
[initialized] :: Term -> Bool
[log] :: Term -> Vector Line
[logpos] :: Term -> Int
[loglen] :: Term -> Int
[buf] :: Term -> Line
[len] :: Term -> Int
[pos] :: Term -> Int
[prompt] :: Term -> Line

-- | TermRes is the result of the input. Returned whenever the user presses
--   a key.
data TermRes

-- | Returns the numeric value on each key press (except enter).
TKey :: Key -> TermRes

-- | Returns the line of data when user presses enter.
TLine :: Line -> TermRes

-- | Line is the datatype of the returned text string when the user presses
--   enter. This type can easily be changed from the default (String) to
--   Text or anything else. Change it in the type alias and it will be used
--   everywhere.
type Line = String

-- | <b>init</b> <i>initial_prompt</i>
--   
--   Initializes the terminal. Returns a handle which you pass on to the
--   <b>input</b> function.
init :: Line -> IO Term

-- | <b>input</b> <i>handle</i>
--   
--   Reads one character from the keyboard. You give it the handle from the
--   last function call. It returns the string when pressed enter and
--   returns the key code otherwise.
--   
--   <b>Example:</b>
--   
--   <pre>
--   &gt; 
--   &gt; import qualified Data.UI (init, input)
--   &gt; import Data.UI (TermRes(..))
--   &gt; 
--   &gt; example :: IO ()
--   &gt; example = do
--   &gt;     t &lt;- Data.UI.init "prompt&gt; "
--   &gt;     go t
--   &gt;     where
--   &gt;      go t' = do
--   &gt;         (res,newstate) &lt;- Data.UI.input t'
--   &gt;         case res of
--   &gt;             TLine x  -&gt; do
--   &gt;                          _ &lt;- putStrLn $ "\nResult: '" &lt;&gt; x &lt;&gt; "'"
--   &gt;                          go newstate
--   &gt;             _        -&gt; go newstate
--   &gt; 
--   </pre>
input :: Term -> IO (TermRes, Term)
instance GHC.Internal.Show.Show Data.UI.Arrow
instance GHC.Internal.Show.Show Data.UI.Term
instance GHC.Internal.Show.Show Data.UI.TermRes