netwire-input (empty) → 0.0.1

raw patch · 5 files changed

+225/−0 lines, 5 filesdep +basedep +netwiresetup-changed

Dependencies added: base, netwire

Files

• LICENSE +21/−0
• README.md +4/−0
• Setup.hs +2/−0
• lib/FRP/Netwire/Input.hs +163/−0
• netwire-input.cabal +35/−0

@@ -0,0 +1,21 @@+The MIT License (MIT)++Copyright (c) 2014 Pavel Krajcevski++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.

@@ -0,0 +1,4 @@+netwire-input+============++A library of wires that provide keyboard, mouse, and joystick input.

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,163 @@+{-|+Module      : FRP.Netwire.Input+Description : Common wires to be used to support input in netwire+Copyright   : (c) Pavel Krajcevski, 2014+License     : MIT+Maintainer  : Krajcevski@gmail.com+Stability   : experimental+Portability : POSIX++This module contains definitions for typeclasses and wires to be used in FRP+programs that use netwire. In order to use this module, an implementation that+provides an instance of one of the underlying typeclasses 'MonadMouse' or+'MonadKeyboard' must be used. In order to not require the GLFW or SDL libraries+as dependencies, these instances are provided in separate libraries.++-}++module FRP.Netwire.Input where++--------------------------------------------------------------------------------+-- Requried modules+import Control.Monad.Fix+import Control.Wire hiding ((.))+import Data.Monoid+--------------------------------------------------------------------------------++--------------------------------------------------------------------------------+-- * Mouse input++-- | Mouse button typeclass. This is used to constrain the type of Monad used+-- | to provide mouse input.+class MouseButton a++-- | The mouse cursor mode. This mode is usually dependent on whether or not+-- the mouse is in the bounds of the application window.+data CursorMode = CursorMode'Disabled -- ^ The mouse cursor is disabled+                | CursorMode'Reset    -- ^ Reset the cursor to zero between computations+                | CursorMode'Hidden   -- ^ The mouse cursor is hidden when over the application+                | CursorMode'Enabled  -- ^ The mouse cursor is enabed and+                                      -- visible over the application+                deriving (Ord, Enum, Eq, Show, Read)++-- ** Mouse input++-- | This monad describes computations that involve mouse input. +class (MouseButton mb, Monad m) => MonadMouse mb m | m -> mb where+  -- | Sets the cursor mode for all subsequent computations. Note, that many+  -- | implementations require some sort of "poll" to read the IO+  setCursorMode :: CursorMode -> m ()+  -- | Returns true if the given mouse button is pressed+  mbIsPressed :: mb -> m (Bool)+  -- | Resets the pressed state of the mouse button+  releaseButton :: mb -> m ()+  -- | Get the current cursor location+  cursor :: m (Float, Float)+  -- | Get the amount of scrolling done in the x and y directions+  scroll :: m (Double, Double)++-- ** Mouse input wires++-- | Ignores its input and returns+-- the current normalized mouse coordinates. Regardless of window size,+-- each of the returned coordinates will be in the range @[-1, 1]@.+-- +-- * Depends: now+-- * Inhibits: never+mouseCursor :: MonadMouse mb m => Wire s e m a (Float, Float)+mouseCursor = mkGen_ $ \_ -> cursor >>= (return . Right)++-- | Returns the change in mouse coordinates between subsequent time instants+-- +-- * Depends: before now+-- * Inhibits: never+mouseDelta :: (MonadFix m, MonadMouse mb m) => Wire s e m a (Float, Float)+mouseDelta = let+  delta (x, y) (x', y') = (x - x', y - y')+  in+   (mouseCursor >>>) $ loop $ second (delay (0, 0)) >>>+   (arr $ \(cur, last) -> (delta cur last, cur))+     +-- | The mouse mickies are the offset from zero at each time instant. If this+-- wire is being used, then it is assuming that the cursor mode is set to+-- 'CursorMode'Reset'+-- +-- * Depends: now+-- * Inhibits: never+mouseMickies :: MonadMouse mb m => Wire s e m a (Float, Float)+mouseMickies =+  (mkGen_ $ \a -> do { setCursorMode CursorMode'Reset; return (Right a) }) >>>+  mouseCursor++-- | Behaves like the identity wire when the mouse button is pressed+-- and inhibits otherwise+-- +-- * Inhibits: when the mouse button is not pressed+mousePressed :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a+mousePressed mouse = mkGen_ $ \x -> do+  pressed <- mbIsPressed mouse+  if pressed+    then return (Right x)+    else return (Left mempty)++-- | Behaves like the identity wire for a signle instant when the mouse button+-- is pressed and otherwise inhibits+-- +-- * Depends: the instant at which the mouse button is pressed+-- * Inhibits: when the mouse button is not pressed or after it has been pressed+mouseDebounced :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a+mouseDebounced mouse = mkGen_ $ \x -> do+  pressed <- mbIsPressed mouse+  if pressed+    then releaseButton mouse >> return (Right x)+    else return (Left mempty)++-- | Behaves like the identity wire, and inhibits immediately after+-- setting the cursor mode. Common uses of this wire are to switch it+-- to the identity wire:+-- @+--   cursorMode CursorMode'Disabled --> mkId+-- @+-- +-- * Inhibits: after now+cursorMode :: (MonadMouse mb m, Monoid e) => CursorMode -> Wire s e m a a+cursorMode mode =+  (mkGenN $ \x -> setCursorMode mode >> (return $ (Right x, mkEmpty)))++--------------------------------------------------------------------------------+-- * Keyboard input++-- | Key typeclass. This is used to constrain the type of Monad used+-- | to provide keyboard input.+class Key a++-- | This monad describes computations that involve keyboard input. +class (Key k, Monad m) => MonadKeyboard k m | m -> k where+  -- | Returns true if the given key is currently pressed+  keyIsPressed :: k -> m (Bool)+  -- | Resets the pressed state of the given key.+  releaseKey :: k -> m ()++-- * Keyboard input wires++-- | Behaves like the identity wire when the key is pressed+-- and inhibits otherwise+-- +-- * Inhibits: when the key is not pressed+keyPressed :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a+keyPressed key = mkGen_ $ \x -> do+  pressed <- keyIsPressed key+  if pressed+    then return (Right x)+    else return (Left mempty)++-- | Behaves like the identity wire for a signle instant when the key+-- is pressed and otherwise inhibits+-- +-- * Inhibits: when the key is not pressed or after it has been pressed+keyDebounced :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a+keyDebounced key = mkGen_ $ \x -> do+  pressed <- keyIsPressed key+  if pressed+    then releaseKey key >> return (Right x)+    else return (Left mempty)

@@ -0,0 +1,35 @@+-- Initial netwire-input.cabal generated by cabal init.  For further +-- documentation, see http://haskell.org/cabal/users-guide/++name:                netwire-input+version:             0.0.1+synopsis:            Input handling abstractions for netwire+description:         This package contains a collection of Monad typeclasses that support+                     interaction with input devices such as keyboard and mice. Moreover, these+                     typeclasses are used to create wires from the netwire package the produce+                     mouse and keyboard input values in a reactive way. This package cannot+                     be used independently and must be used with another package that provides+                     instantiation of these typeclasses such as netwire-input-glfw.+homepage:            https://www.github.com/Mokosha/netwire-input+license:             MIT+license-file:        LICENSE+author:              Pavel Krajcevski+maintainer:          Krajcevski@gmail.com+copyright:           Pavel Krajcevski, 2014+category:            Game+build-type:          Simple+extra-source-files:  README.md+cabal-version:       >= 1.10++source-repository head+  type:           git+  location:       git@github.com:Mokosha/netwire-input.git++library+  default-extensions:  FunctionalDependencies+                       MultiParamTypeClasses+  exposed-modules:     FRP.Netwire.Input+  build-depends:       base >=4.7 && <4.8,+                       netwire >= 5+  hs-source-dirs:      lib+  default-language:    Haskell2010