hotswap 0.1.8.0 → 0.1.9.2

raw patch · 2 files changed

+42/−6 lines, 2 filesPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

API changes (from Hackage documentation)

Files

• hotswap.cabal +1/−1
• src/System/Plugins/Hotswap.hs +41/−5

@@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/  name:                hotswap-version:             0.1.8.0+version:             0.1.9.2 synopsis:            Simple code hotswapping. description:         A simple, high-level interface to plugins. homepage:            https://github.com/mikeplus64/hotswap

@@ -1,4 +1,13 @@-module System.Plugins.Hotswap (newPlugin, Plugin (..), usePlugin, reloadPlugin) where+module System.Plugins.Hotswap (+    Plugin (..), +    newPlugin,+    usePlugin, +    usePluginIO,+    reloadPlugin, +    readPlugin, +    withPlugin,+    withPluginIO+) where  import System.Plugins.Load import Data.IORef @@ -6,23 +15,43 @@ data Plugin a = Plugin {     pluginObject       :: FilePath,    -- ^ Path to object     pluginIncludes     :: [FilePath],  -- ^ Include paths.-    pluginFunctionName :: String,      -- ^ Name of the symbol to find.-    pluginFunction     :: IORef a,     -- ^ Loaded function.+    pluginDataName     :: String,      -- ^ Name of the symbol to find.+    pluginData         :: IORef a,     -- ^ Loaded data.     pluginModule       :: IORef Module -- ^ Loaded module. }  -- | 'usePlugin' provides a simple way to use plugins of type 'Plugin (a -> b)', ie, only  -- single argumented ones. usePlugin :: Plugin (a -> b) -> a -> IO b-usePlugin p x = fmap ($ x) $ readIORef $ pluginFunction p+usePlugin plug x = do+    pf <- readPlugin plug+    return (pf x) +-- | 'usePlugin' for plugins returning IO.+usePluginIO :: Plugin (a -> IO b) -> a -> IO b+usePluginIO plug x = do+    pf <- readPlugin plug+    pf x++-- | 'withPlugin' provides a way to run a function on a plugin, modifying the plugin in-place.+withPlugin :: Plugin a -> (a -> a) -> IO ()+withPlugin plug f = do+    pd <- readPlugin plug +    putPlugin plug (f pd)++-- | 'withPlugin' for functions returning IO.+withPluginIO :: Plugin a -> (a -> IO a) -> IO ()+withPluginIO plug f = do+    pd <- readPlugin plug+    r  <- f pd+    putPlugin plug r+ -- | Create a new plugin. Don't use this to reload plugins. newPlugin :: FilePath -> [FilePath] -> String -> IO (Plugin a) newPlugin obj incs name = do     plugin <- load_ obj incs name      case plugin of-         LoadSuccess m f -> do             fref <- newIORef f             mref <- newIORef m@@ -41,3 +70,10 @@             writeIORef fref newf         _ -> error "no such module or function" +-- | Read the 'pluginData' 'IORef'.+readPlugin :: Plugin a -> IO a+readPlugin = readIORef . pluginData++-- | Replace the contents of the 'pluginData'.+putPlugin :: Plugin a -> a -> IO ()+putPlugin = writeIORef . pluginData