{-# LANGUAGE ExistentialQuantification #-}
{- |
Module      :  Neovim.Plugin.Internal
Description :  Split module that can import Neovim.Context without creating import circles
Copyright   :  (c) Sebastian Witte
License     :  Apache-2.0

Maintainer  :  woozletoff@gmail.com
Stability   :  experimental
Portability :  GHC

-}
module Neovim.Plugin.Internal (
    ExportedFunctionality(..),
    getFunction,
    getDescription,
    NeovimPlugin(..),
    Plugin(..),
    wrapPlugin,
    ) where

import           Neovim.Context
import           Neovim.Plugin.Classes

import           Data.MessagePack


-- | This data type is used in the plugin registration to properly register the
-- functions.
newtype ExportedFunctionality env
    = EF (FunctionalityDescription, [Object] -> Neovim env Object)


-- | Extract the description of an 'ExportedFunctionality'.
getDescription :: ExportedFunctionality env -> FunctionalityDescription
getDescription :: ExportedFunctionality env -> FunctionalityDescription
getDescription (EF (FunctionalityDescription
d,[Object] -> Neovim env Object
_)) = FunctionalityDescription
d


-- | Extract the function of an 'ExportedFunctionality'.
getFunction :: ExportedFunctionality env -> [Object] -> Neovim env Object
getFunction :: ExportedFunctionality env -> [Object] -> Neovim env Object
getFunction (EF (FunctionalityDescription
_, [Object] -> Neovim env Object
f)) = [Object] -> Neovim env Object
f


instance HasFunctionName (ExportedFunctionality env) where
    name :: ExportedFunctionality env -> FunctionName
name = FunctionalityDescription -> FunctionName
forall a. HasFunctionName a => a -> FunctionName
name (FunctionalityDescription -> FunctionName)
-> (ExportedFunctionality env -> FunctionalityDescription)
-> ExportedFunctionality env
-> FunctionName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ExportedFunctionality env -> FunctionalityDescription
forall env. ExportedFunctionality env -> FunctionalityDescription
getDescription
    nvimMethod :: ExportedFunctionality env -> NvimMethod
nvimMethod = FunctionalityDescription -> NvimMethod
forall a. HasFunctionName a => a -> NvimMethod
nvimMethod (FunctionalityDescription -> NvimMethod)
-> (ExportedFunctionality env -> FunctionalityDescription)
-> ExportedFunctionality env
-> NvimMethod
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ExportedFunctionality env -> FunctionalityDescription
forall env. ExportedFunctionality env -> FunctionalityDescription
getDescription


-- | This data type contains meta information for the plugin manager.
--
data Plugin env = Plugin
    { Plugin env -> env
environment :: env
    , Plugin env -> [ExportedFunctionality env]
exports     :: [ExportedFunctionality env]
    }


-- | 'Plugin' values are wraped inside this data type via 'wrapPlugin' so that
-- we can put plugins in an ordinary list.
data NeovimPlugin = forall env. NeovimPlugin (Plugin env)


-- | Wrap a 'Plugin' in some nice blankets, so that we can put them in a simple
-- list.
wrapPlugin :: Applicative m => Plugin env -> m NeovimPlugin
wrapPlugin :: Plugin env -> m NeovimPlugin
wrapPlugin = NeovimPlugin -> m NeovimPlugin
forall (f :: * -> *) a. Applicative f => a -> f a
pure (NeovimPlugin -> m NeovimPlugin)
-> (Plugin env -> NeovimPlugin) -> Plugin env -> m NeovimPlugin
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Plugin env -> NeovimPlugin
forall env. Plugin env -> NeovimPlugin
NeovimPlugin