Documentation, exports and minor stuff

neovimhaskell · Mar 25, 2018 · be18330 · be18330
1 parent 6ab5884
commit be18330
Show file tree

Hide file tree

Showing 14 changed files with 83 additions and 75 deletions.
diff --git a/library/Neovim.hs b/library/Neovim.hs
@@ -54,10 +54,6 @@ module Neovim (
 
     ask,
     asks,
-    put,
-    get,
-    gets,
-    modify,
 
     -- ** Creating a stateful plugin
     -- $statefulplugin
@@ -69,8 +65,6 @@ module Neovim (
     waitErr,
     waitErr',
     err,
-    Doc,
-    Pretty(..),
     errOnInvalidResult,
     NeovimException(..),
     -- ** Generated functions for neovim interaction
@@ -85,6 +79,11 @@ module Neovim (
     unlessM,
     docToObject,
     docFromObject,
+    Doc,
+    AnsiStyle,
+    Pretty(..),
+    putDoc,
+    exceptionToDoc,
     Priority(..),
     module Control.Monad,
     module Control.Applicative,
@@ -106,10 +105,12 @@ import           Neovim.API.String
 import           Neovim.API.TH                (autocmd, command, command',
                                                function, function')
 import           Neovim.Classes               (Dictionary, NvimObject (..),
+                                               Doc, AnsiStyle, Pretty(..),
                                                docFromObject, docToObject, (+:))
 import           Neovim.Config                (NeovimConfig (..))
 import           Neovim.Context               (Neovim,
-                                               NeovimException (ErrorMessage),
+                                               NeovimException(..),
+                                               exceptionToDoc,
                                                ask, asks, err,
                                                errOnInvalidResult, get, gets,
                                                modify, put)
@@ -128,8 +129,7 @@ import           Neovim.RPC.FunctionCall      (wait, wait', waitErr, waitErr')
 import           Neovim.Util                  (unlessM, whenM,
                                                withCustomEnvironment)
 import           System.Log.Logger            (Priority (..))
-import           Data.Text.Prettyprint.Doc    (Doc, Pretty (..))
-
+import           Data.Text.Prettyprint.Doc.Render.Terminal (putDoc)
 -- Installation {{{1
 {- $installation
 

diff --git a/library/Neovim/API/Parser.hs b/library/Neovim/API/Parser.hs
@@ -24,7 +24,6 @@ import qualified Data.ByteString                           as B
 import           Data.Map                                  (Map)
 import qualified Data.Map                                  as Map
 import           Data.MessagePack
-import           Data.Monoid
 import           Data.Serialize
 import           Neovim.Compat.Megaparsec                  as P
 import           System.IO                                 (hClose)

diff --git a/library/Neovim/API/TH.hs b/library/Neovim/API/TH.hs
@@ -309,7 +309,7 @@ data ArgType = StringyType
 
 
 -- | Given a value of type 'Type', test whether it can be classified according
--- to the constructors of 'ArgType'.
+-- to the constructors of "ArgType".
 classifyArgType :: Type -> Q ArgType
 classifyArgType t = do
     set <- genStringTypesSet

diff --git a/library/Neovim/Classes.hs b/library/Neovim/Classes.hs
@@ -48,12 +48,10 @@ import           Data.Int                                  (Int16, Int32, Int64,
 import qualified Data.Map.Strict                           as SMap
 import           Data.MessagePack
 import           Data.Monoid
-import           Data.String                               (IsString (..))
 import           Data.Text                                 as Text (Text)
 import           Data.Text.Prettyprint.Doc                 (Doc, Pretty (..),
                                                             defaultLayoutOptions,
-                                                            layoutPretty,
-                                                            lparen, rparen,
+                                                            layoutPretty, viaShow,
                                                             (<+>))
 import qualified Data.Text.Prettyprint.Doc                 as P
 import           Data.Text.Prettyprint.Doc.Render.Terminal (AnsiStyle,
@@ -76,6 +74,9 @@ import           Prelude
 infixr 5 +:
 
 -- | Convenient operator to create a list of 'Object' from normal values.
+-- @
+-- values +: of :+ different :+ types :+ can +: be +: combined +: this +: way +: []
+-- @
 (+:) :: (NvimObject o) => o -> [Object] -> [Object]
 o +: os = toObject o : os
 
@@ -157,7 +158,7 @@ instance NvimObject Double where
     fromObject (ObjectInt o)    = return $ fromIntegral o
     fromObject (ObjectUInt o)   = return $ fromIntegral o
     fromObject o                = throwError $ "Expected ObjectDouble, but got"
-                                                <+> pretty (show o)
+                                                <+> viaShow o
 
 
 instance NvimObject Integer where
@@ -167,7 +168,7 @@ instance NvimObject Integer where
     fromObject (ObjectUInt o)   = return $ toInteger o
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected ObjectInt, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected ObjectInt, but got" <+> viaShow o
 
 
 instance NvimObject Int64 where
@@ -177,7 +178,7 @@ instance NvimObject Int64 where
     fromObject (ObjectUInt o)   = return $ fromIntegral o
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Int32 where
@@ -187,7 +188,7 @@ instance NvimObject Int32 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Int16 where
@@ -197,7 +198,7 @@ instance NvimObject Int16 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Int8 where
@@ -207,7 +208,7 @@ instance NvimObject Int8 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Word where
@@ -217,7 +218,7 @@ instance NvimObject Word where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Word64 where
@@ -227,7 +228,7 @@ instance NvimObject Word64 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Word32 where
@@ -237,7 +238,7 @@ instance NvimObject Word32 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Word16 where
@@ -247,7 +248,7 @@ instance NvimObject Word16 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Word8 where
@@ -257,7 +258,7 @@ instance NvimObject Word8 where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance NvimObject Int where
@@ -267,22 +268,22 @@ instance NvimObject Int where
     fromObject (ObjectUInt i)   = return $ fromIntegral i
     fromObject (ObjectDouble o) = return $ round o
     fromObject (ObjectFloat o)  = return $ round o
-    fromObject o                = throwError $ "Expected any Integer value, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected any Integer value, but got" <+> viaShow o
 
 
 instance {-# OVERLAPPING #-} NvimObject [Char] where
     toObject                    = ObjectBinary . UTF8.fromString
 
     fromObject (ObjectBinary o) = return $ UTF8.toString o
     fromObject (ObjectString o) = return $ UTF8.toString o
-    fromObject o                = throwError $ "Expected ObjectString, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected ObjectString, but got" <+> viaShow o
 
 
 instance {-# OVERLAPPABLE #-} NvimObject o => NvimObject [o] where
     toObject                    = ObjectArray . map toObject
 
     fromObject (ObjectArray os) = mapM fromObject os
-    fromObject o                = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance NvimObject o => NvimObject (Maybe o) where
@@ -320,23 +321,23 @@ instance (Ord key, NvimObject key, NvimObject val)
                     . (fromObject *** fromObject))
                 . SMap.toList) om
 
-    fromObject o = throwError $ "Expected ObjectMap, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectMap, but got" <+> viaShow o
 
 
 instance NvimObject Text where
     toObject                    = ObjectBinary . encodeUtf8
 
     fromObject (ObjectBinary o) = return $ decodeUtf8 o
     fromObject (ObjectString o) = return $ decodeUtf8 o
-    fromObject o                = throwError $ "Expected ObjectBinary, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected ObjectBinary, but got" <+> viaShow o
 
 
 instance NvimObject ByteString where
     toObject                    = ObjectBinary
 
     fromObject (ObjectBinary o) = return o
     fromObject (ObjectString o) = return o
-    fromObject o                = throwError $ "Expected ObjectBinary, but got" <+> pretty (show o)
+    fromObject o                = throwError $ "Expected ObjectBinary, but got" <+> viaShow o
 
 
 instance NvimObject Object where
@@ -353,7 +354,7 @@ instance (NvimObject o1, NvimObject o2) => NvimObject (o1, o2) where
     fromObject (ObjectArray [o1, o2]) = (,)
         <$> fromObject o1
         <*> fromObject o2
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3) => NvimObject (o1, o2, o3) where
     toObject (o1, o2, o3) = ObjectArray $ [toObject o1, toObject o2, toObject o3]
@@ -362,7 +363,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3) => NvimObject (o1, o2, o3
         <$> fromObject o1
         <*> fromObject o2
         <*> fromObject o3
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4) => NvimObject (o1, o2, o3, o4) where
@@ -373,7 +374,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4) => NvimObj
         <*> fromObject o2
         <*> fromObject o3
         <*> fromObject o4
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5) => NvimObject (o1, o2, o3, o4, o5) where
@@ -385,7 +386,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject
         <*> fromObject o3
         <*> fromObject o4
         <*> fromObject o5
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6) => NvimObject (o1, o2, o3, o4, o5, o6) where
@@ -398,7 +399,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject
         <*> fromObject o4
         <*> fromObject o5
         <*> fromObject o6
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7) => NvimObject (o1, o2, o3, o4, o5, o6, o7) where
@@ -412,7 +413,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject
         <*> fromObject o5
         <*> fromObject o6
         <*> fromObject o7
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7, NvimObject o8) => NvimObject (o1, o2, o3, o4, o5, o6, o7, o8) where
@@ -427,7 +428,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject
         <*> fromObject o6
         <*> fromObject o7
         <*> fromObject o8
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject o5, NvimObject o6, NvimObject o7, NvimObject o8, NvimObject o9) => NvimObject (o1, o2, o3, o4, o5, o6, o7, o8, o9) where
@@ -443,7 +444,7 @@ instance (NvimObject o1, NvimObject o2, NvimObject o3, NvimObject o4, NvimObject
         <*> fromObject o7
         <*> fromObject o8
         <*> fromObject o9
-    fromObject o = throwError $ "Expected ObjectArray, but got" <+> pretty (show o)
+    fromObject o = throwError $ "Expected ObjectArray, but got" <+> viaShow o
 
 
 -- 1}}}
diff --git a/library/Neovim/Context.hs b/library/Neovim/Context.hs
@@ -15,6 +15,7 @@ module Neovim.Context (
 
     Neovim,
     NeovimException(..),
+    exceptionToDoc,
     FunctionMap,
     FunctionMapEntry,
     mkFunctionMap,
@@ -63,9 +64,6 @@ import           Control.Monad.Reader
 import           Control.Monad.State
 import           Data.MessagePack             (Object)
 
-import           Data.Text.Prettyprint.Doc    (Pretty(..), defaultLayoutOptions, layoutPretty)
-import           Data.Text.Prettyprint.Doc.Render.Text (renderStrict)
-
 
 -- | @'throw'@ specialized to a 'Pretty' value.
 err :: Doc AnsiStyle -> Neovim env a
@@ -85,8 +83,6 @@ errOnInvalidResult a = a >>= \case
 
         Right x ->
             return x
-    Left o ->
-        (err . exceptionToDoc) o
 
 
 

diff --git a/library/Neovim/Exceptions.hs b/library/Neovim/Exceptions.hs
@@ -20,9 +20,7 @@ module Neovim.Exceptions
 import           Control.Exception                         (Exception)
 import           Data.MessagePack                          (Object (..))
 import           Data.String                               (IsString (..))
-import           Data.Text                                 (Text)
-import           Data.Text.Prettyprint.Doc                 (Doc, Pretty (..),
-                                                            (<+>), viaShow)
+import           Data.Text.Prettyprint.Doc                 (Doc, (<+>), viaShow)
 import           Data.Text.Prettyprint.Doc.Render.Terminal (AnsiStyle)
 import           Data.Typeable                             (Typeable)
 

diff --git a/library/Neovim/Plugin.hs b/library/Neovim/Plugin.hs
@@ -52,7 +52,6 @@ import           Data.Map                     (Map)
 import qualified Data.Map                     as Map
 import           Data.Maybe                   (catMaybes)
 import           Data.MessagePack
-import           Data.Text.Prettyprint.Doc    (Doc, Pretty (..), viaShow, (<+>))
 import           Data.Traversable             (forM)
 import           System.Log.Logger
 import           UnliftIO.Async               (Async, async, race)