Debian Codegraph @

src/Yi/Keymap/Keys.hs

raw
1 {-# LANGUAGE FlexibleContexts #-}
2 {-# LANGUAGE OverloadedStrings #-}
3 {-# OPTIONS_HADDOCK show-extensions #-}
4
5 -- |
6 -- Module : Yi.Keymap.Keys
7 -- License : GPL-2
8 -- Maintainer : [email protected]
9 -- Stability : experimental
10 -- Portability : portable
11 --
12 -- Combinators for building keymaps.
13
14 module Yi.Keymap.Keys
15 (
16 module Yi.Event,
17 module Yi.Interact,
18 printableChar, textChar,
19 charOf, shift, meta, ctrl, super, hyper, spec, char,
20 (>>!), (>>=!), (?>>), (?>>!), (?*>>), (?*>>!),
21 ctrlCh, metaCh, hyperCh,
22 optMod,
23 pString
24 ) where
25
26 import Prelude hiding (error)
27
28 import Control.Monad (unless)
29 import qualified Control.Monad.Fail as Fail
30 import Data.Char (isAlpha, isPrint, toUpper)
31 import Data.List (nub, sort)
32 import Yi.Debug (error)
33 import Yi.Event (Event (..), Key (..), Modifier (..), eventToChar, prettyEvent)
34 import Yi.Interact hiding (write)
35 import Yi.Keymap (Action, KeymapM, YiAction, write)
36
37 printableChar :: (Fail.MonadFail m, MonadInteract m w Event) => m Char
38 printableChar = do
39 Event (KASCII c) [] <- anyEvent
40 unless (isPrint c) $
41 fail "unprintable character"
42 return c
43
44 -- | Parse any character that can be inserted in the text.
45 textChar :: KeymapM Char
46 textChar = do
47 -- Why only ASCII?
48 Event (KASCII c) [] <- anyEvent
49 return c
50
51 pString :: (MonadInteract m w Event) => String -> m [Event]
52 pString = events . map char
53
54 charOf :: (Fail.MonadFail m, MonadInteract m w Event) => (Event -> Event) -> Char -> Char -> m Char
55 charOf modifier l h =
56 do Event (KASCII c) _ <- eventBetween (modifier $ char l) (modifier $ char h)
57 return c
58
59 shift,ctrl,meta,super,hyper :: Event -> Event
60 shift (Event (KASCII c) ms) | isAlpha c = Event (KASCII (toUpper c)) ms
61 | otherwise = error "shift: unhandled event"
62 shift (Event k ms) = Event k $ nub $ sort (MShift:ms)
63
64 ctrl (Event k ms) = Event k $ nub $ sort (MCtrl:ms)
65
66 meta (Event k ms) = Event k $ nub $ sort (MMeta:ms)
67
68 super (Event k ms) = Event k $ nub $ sort (MSuper:ms)
69
70 hyper (Event k ms) = Event k $ nub $ sort (MHyper:ms)
71
72 char :: Char -> Event
73 char '\t' = Event KTab []
74 char '\r' = Event KEnter []
75 char '\n' = Event KEnter []
76 char c = Event (KASCII c) []
77
78 ctrlCh :: Char -> Event
79 ctrlCh = ctrl . char
80
81 metaCh :: Char -> Event
82 metaCh = meta . char
83
84 hyperCh :: Char -> Event
85 hyperCh = hyper . char
86
87 -- | @optMod f ev@ produces a 'MonadInteract' that consumes @ev@ or @f ev@
88 optMod ::(Fail.MonadFail m, MonadInteract m w Event) => (Event -> Event) -> Event -> m Event
89 optMod f ev = oneOf [ev, f ev]
90
91 -- | Convert a special key into an event
92 spec :: Key -> Event
93 spec k = Event k []
94
95 -- | > p >>! act = p >> 'write' act
96 (>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => m b -> a -> m ()
97 p >>! act = p >> write act
98
99 -- | > p >>=! act = p >>= 'write' . act
100 (>>=!) :: (MonadInteract m Action Event, YiAction a x, Show x) => m b -> (b -> a) -> m ()
101 p >>=! act = p >>= write . act
102
103 -- | @ ev ?>> proc = 'event' ev >> proc @
104 (?>>) :: (MonadInteract m action Event) => Event -> m a -> m a
105 ev ?>> proc = event ev >> proc
106
107 -- | @ ev ?>>! act = 'event' ev >> 'write' act @
108 (?>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => Event -> a -> m ()
109 ev ?>>! act = event ev >> write act
110
111 -- | @ ev ?*>> proc = 'events' ev >> proc @
112 (?*>>) :: (MonadInteract m action Event) => [Event] -> m a -> m a
113 ev ?*>> proc = events ev >> proc
114
115 -- | @ ev ?*>>! act = 'events' ev >> 'write' act @
116 (?*>>!) :: (MonadInteract m Action Event, YiAction a x, Show x) => [Event] -> a -> m ()
117 ev ?*>>! act = events ev >> write act
118
119 infixl 1 >>!
120 infixl 1 >>=!
121 infixr 0 ?>>!
122 infixr 0 ?>>
123 infixr 0 ?*>>!
124 infixr 0 ?*>>