Introduce BufTextChanged event (hiding text lenses and range lens)

Author: clojj

.gitignore

@@ -19,3 +19,4 @@ cabal.sandbox.config
 cabal.project.local
 .HTF/
 *.log
+.imdone/

rasa-example-config/app/Main.hs

@@ -29,4 +29,4 @@ main = rasa $ do
   logger
   slate
   style
-  onInit . void $ newBuffer "This is a buffer to get you started!\nYou can also pass command line args to rasa"
+  onInit . void $ newBuffer "This is a buffer to get you started!\nYou can also pass command line args to rasa"

rasa-ext-cursors/src/Rasa/Ext/Cursors/Internal/Actions.hs

@@ -51,7 +51,7 @@ findNext pat = do
 -- | Get the 'Coord' of the next occurence of the given text after the given 'Coord'
 findNextFrom :: Y.YiString -> Coord -> BufAction Coord
 findNextFrom pat c = do
-  distance <- use (text . afterC c . asText . tillNext (Y.toText pat) . from asText . to sizeOf)
+  distance <- use (getText . afterC c . asText . tillNext (Y.toText pat) . from asText . to sizeOf)
   return (distance + c)
 
 -- | Move all ranges to the location of the previous occurence of the given text.
@@ -66,9 +66,9 @@ findPrev pat = do
 -- | Get the 'Coord' of the previous occurence of the given text before the given 'Coord'
 findPrevFrom :: Y.YiString -> Coord -> BufAction Coord
 findPrevFrom pat c = do
-  txt <- use text
+  txt <- use getText
   let Offset o = c^.from (asCoord txt)
-  distance <- use (text . asText . before o . tillPrev (Y.toText pat) . to T.length .to negate)
+  distance <- use (getText . asText . before o . tillPrev (Y.toText pat) . to T.length .to negate)
   return ((Offset $ distance + o)^.asCoord txt)
 
 -- | Move all ranges by the given number of columns

rasa-ext-cursors/src/Rasa/Ext/Cursors/Internal/Base.hs

@@ -47,7 +47,7 @@ cleanRanges txt = fmap (ensureSize . clampRange txt) . reverse . nub . sort
 ranges :: HasBuffer s => Lens' s [CrdRange]
 ranges = lens getter setter
   where getter buf = buf^.bufExt.cursors
-        setter buf new = let txt = buf^.text
+        setter buf new = let txt = buf^.getText
                           in buf & bufExt.cursors .~ cleanRanges txt new
 
 -- | A Traversal over each Range for the given buffer.

rasa-ext-files/src/Rasa/Ext/Files.hs

@@ -47,7 +47,7 @@ showFilename = focusDo_ $ do
       where disp name = "<" <> name <> ">"
 
 saveAs :: Y.YiString -> BufAction ()
-saveAs fName = use text >>= liftIO . TIO.writeFile (Y.toString fName) . Y.toText
+saveAs fName = use getText >>= liftIO . TIO.writeFile (Y.toString fName) . Y.toText
 
 save :: BufAction ()
 save = do

rasa-ext-slate/src/Rasa/Ext/Slate/Internal/Render.hs

@@ -84,7 +84,7 @@ renderView (width, height) (vw, buf) = appendActiveBar . resize . addEndBar $ te
     textImage :: V.Image
     textImage = applyAttrs adjustedStyles txt
     txt :: Y.YiString
-    txt = buf^.text & trimText
+    txt = buf^.getText & trimText
     adjustedStyles :: [Span CrdRange V.Attr]
     adjustedStyles = bimap adjustStylePositions convertStyle <$> buf^.styles
     adjustStylePositions :: CrdRange -> CrdRange

rasa-ext-vim/src/Rasa/Ext/Vim.hs

@@ -120,7 +120,7 @@ normal [KDown] = liftAction focusViewBelow
 
 
 normal [Keypress 'G' []] = do
-  txt <- use text
+  txt <- use getText
   ranges.= [Range ((Offset $ Y.length txt - 1)^.asCoord txt) ((Offset $ Y.length txt)^.asCoord txt)]
 
 normal [Keypress 'o' []] = endOfLine >> insertText "\n" >> moveRangesByN 1 >> mode .= Insert

rasa/src/Rasa/Ext.hs

@@ -107,10 +107,8 @@ module Rasa.Ext
   , HasBuffer
   , BufRef
   , HasEditor
-  , text
-  -- | A lens over the buffer's Text as a 'Yi.Rope.YiString'. Use within a 'BufAction':
-  --
-  -- > txt <- use text
+  , getText
+  , getRange
 
   -- * Events
   , Keypress(..)
@@ -143,6 +141,7 @@ module Rasa.Ext
   , afterNextRender
   , onExit
   , onBufAdded
+  , onBufTextChanged
 
    -- * Ranges
   , Range(..)
@@ -160,7 +159,6 @@ module Rasa.Ext
   , asCoord
   , clampCoord
   , clampRange
-  , range
   , rStart
   , rEnd
   , sizeOfR

rasa/src/Rasa/Internal/Buffer.hs

@@ -13,6 +13,7 @@ module Rasa.Internal.Buffer
   ( Buffer
   , HasBuffer(..)
   , text
+  , getText
   , bufExt
   , Ext(..)
   , mkBuffer
@@ -50,6 +51,10 @@ instance HasBuffer Buffer where
 text :: HasBuffer b => Lens' b Y.YiString
 text = buffer.text'
 
+-- | This getter-lens focuses the text of the in-scope buffer.
+getText :: HasBuffer b => Getting r b Y.YiString
+getText = buffer.text'
+  
 -- | This lens focuses the Extensions States map of the in-scope buffer.
 bufExts :: HasBuffer b => Lens' b ExtMap
 bufExts = buffer.bufExts'

rasa/src/Rasa/Internal/Directive.hs

@@ -24,7 +24,6 @@ module Rasa.Internal.Directive
   , sizeOf
   ) where
 
-import Rasa.Internal.Text
 import Rasa.Internal.Editor
 import Rasa.Internal.Action
 import Rasa.Internal.Range
@@ -119,17 +118,19 @@ exit = exiting .= True
 
 -- | Deletes the text in the given range from the buffer.
 deleteRange :: CrdRange -> BufAction ()
-deleteRange r = range r.asText .= ""
+deleteRange r = replaceRange r ""
 
 -- | Replaces the text in the given range from the buffer.
 replaceRange :: CrdRange -> Y.YiString -> BufAction ()
-replaceRange r txt = range r .= txt
+replaceRange r txt = overRange r (const txt)
 
 -- | Inserts text into the buffer at the given Coord.
 insertAt :: Coord -> Y.YiString -> BufAction ()
-insertAt c txt = range (Range c c) .= txt
+insertAt c = replaceRange r
+  where r = Range c c
 
 -- | Runs the given function over the text in the range, replacing it with the results.
 overRange :: CrdRange -> (Y.YiString -> Y.YiString) -> BufAction ()
-overRange r f = range r %= f
-
+overRange r f = do
+  newText <- range r <%= f
+  liftAction $ dispatchEvent (BufTextChanged r newText)

rasa/src/Rasa/Internal/Events.hs

@@ -9,10 +9,13 @@ module Rasa.Internal.Events
   , BufAdded(..)
   , Keypress(..)
   , Mod(..)
+  , BufTextChanged(..)
   ) where
 
 import Data.Dynamic
 import Rasa.Internal.Editor
+import Rasa.Internal.Range
+import qualified Yi.Rope as Y
 
 -- | The Event type represents a common denominator for all actions that could
 -- occur Event transmitters express events that have occured as a member of this
@@ -64,3 +67,8 @@ data Mod
   | Alt
   | Shift
   deriving (Show, Eq)
+
+data BufTextChanged
+  = BufTextChanged CrdRange Y.YiString
+  deriving (Show, Eq, Typeable)
+  

rasa/src/Rasa/Internal/Range.hs

@@ -22,6 +22,7 @@ module Rasa.Internal.Range
   , range
   , rStart
   , rEnd
+  , getRange
   , sizeOf
   , sizeOfR
   , moveRange
@@ -249,3 +250,8 @@ range :: HasBuffer s =>  CrdRange -> Lens' s Y.YiString
 range (Range start end) = lens getter setter
   where getter = view (text . beforeC end . afterC start)
         setter old new = old & text . beforeC end . afterC start .~ new
+
+-- | A getter-lens over text which is encompassed by a 'Range'
+getRange :: HasBuffer s => CrdRange -> Getting r s Y.YiString
+getRange (Range start end) = to getter
+  where getter = view (text . beforeC end . afterC start)

rasa/src/Rasa/Internal/Scheduler.hs

@@ -24,19 +24,22 @@ module Rasa.Internal.Scheduler
   , removeListener
   , matchingHooks
   , onBufAdded
+  , onBufTextChanged
   ) where
 
 
 import Rasa.Internal.Action
 import Rasa.Internal.Events
 import Rasa.Internal.Editor
+import Rasa.Internal.Range
 
 import Control.Lens
 import Control.Monad
 import Data.Dynamic
 import Data.Foldable
 import Data.Map hiding (filter)
 import Unsafe.Coerce
+import qualified Yi.Rope as Y
 
 -- | Use this to dispatch an event of any type, any hooks which are listening for this event will be triggered
 -- with the provided event. Use this within an Action.
@@ -167,3 +170,8 @@ onBufAdded :: (BufRef -> Action ()) -> Action HookId
 onBufAdded f = onEveryTrigger listener
   where
     listener (BufAdded bRef) = f bRef
+
+onBufTextChanged :: (CrdRange -> Y.YiString -> Action ()) -> Action HookId
+onBufTextChanged f = onEveryTrigger listener
+  where
+    listener (BufTextChanged r newText) = f r newText