regexdispatcher: fix plugin data handling in combination with pluginp…

…rocess

src/bindings/haskell/libelektra-haskell.cabal.in

@@ -22,13 +22,15 @@ library
                    , Elektra.Ease
                    , Elektra.Errors
                    , Elektra.Invoke
+                   , Elektra.PluginProcess
   build-depends:     base >= 4.9 && < 4.12
   includes:          kdb.h
                    , kdbplugin.h
                    , kdbease.h
                    , kdbinvoke.h
                    , kdberrors.h
                    , hskdberrors.h
+                   , kdbpluginprocess.h
   include-dirs:      @CABAL_INCLUDE_DIRS@
                    , "@CMAKE_CURRENT_SOURCE_DIR@/src/include"
   c-sources:         "@CMAKE_CURRENT_BINARY_DIR@/src/c/hskdberrors.c"

src/bindings/haskell/src/Elektra/Plugin.chs

@@ -6,7 +6,7 @@
 -- @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
 -- 
 module Elektra.Plugin (
-  Plugin, PluginStatus (..), PluginData (..),
+  Plugin, withPlugin, PluginStatus (..), PluginData (..),
   elektraPluginGetConfig, 
   elektraPluginSetData, elektraPluginGetData,
   elektraPluginOpenWith, elektraPluginCloseWith, 

src/bindings/haskell/src/Elektra/Pluginprocess.chs

@@ -0,0 +1,30 @@
+--
+-- @file
+--
+-- @brief PluginProcess Haskell bindings
+--
+-- @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
+-- 
+module Elektra.PluginProcess (
+  elektraPluginProcessGetData,
+  elektraPluginProcessSetData
+) where
+
+{#import Elektra.Plugin#}
+{#import Elektra.Invoke#}
+
+import Foreign.Ptr (Ptr)
+
+#include <kdbpluginprocess.h>
+
+-- ***
+-- PLUGINPROCESS METHODS
+-- ***
+
+elektraPluginProcessSetData :: PluginData d => Plugin -> d -> IO ()
+elektraPluginProcessSetData p = store (elektraPluginProcessSetDataRaw p)
+{#fun unsafe elektraPluginProcessSetData as elektraPluginProcessSetDataRaw {`Plugin', `Ptr ()'} -> `()' #}
+
+elektraPluginProcessGetData :: PluginData d => Plugin -> IO (Maybe d)
+elektraPluginProcessGetData p = retrieve <$> elektraPluginProcessGetDataRaw p
+{#fun unsafe elektraPluginProcessGetData as elektraPluginProcessGetDataRaw {`Plugin'} -> `Ptr ()' #}

src/include/kdbpluginprocess.h

@@ -40,6 +40,9 @@ int elektraPluginProcessSend (const ElektraPluginProcess *, pluginprocess_t, Key
 
 int elektraPluginProcessClose (ElektraPluginProcess *, Key *);
 
+void elektraPluginProcessSetData (Plugin * handle, void * data);
+void * elektraPluginProcessGetData (Plugin * handle);
+
 #ifdef __cplusplus
 }
 }

src/libs/pluginprocess/pluginprocess.c

@@ -31,6 +31,7 @@ struct _ElektraPluginProcess
 	int pid;
 	int counter;
 	ElektraInvokeHandle * dump;
+	void * pluginData;
 };
 
 static void cleanupPluginData (ElektraPluginProcess * pp, Key * errorKey)
@@ -333,6 +334,7 @@ ElektraPluginProcess * elektraPluginProcessInit (Key * errorKey)
 	pp->resultPipe = getPipename (pp->pipeDirectory, "/result");
 	pp->dump = elektraInvokeOpen ("dump", 0, errorKey);
 	pp->counter = 0;
+	pp->pluginData = NULL;
 
 	if (pp->pipeDirectory && pp->commandPipe && pp->resultPipe && pp->dump)
 	{
@@ -401,3 +403,34 @@ int elektraPluginProcessClose (ElektraPluginProcess * pp, Key * errorKey)
 	if (done) cleanupPluginData (pp, errorKey);
 	return done;
 }
+
+/** Store a pointer to any plugin related data that is being executed inside an own process.
+ *
+ * @param plugin a pointer to the plugin
+ * @param data the pointer to the data
+ */
+void elektraPluginProcessSetData (Plugin * handle, void * data)
+{
+	ElektraPluginProcess * pp = elektraPluginGetData (handle);
+	if (pp)
+	{
+		pp->pluginData = data;
+	}
+}
+
+/** Get a pointer to any plugin related data stored before.
+ *
+ * If elektraPluginProcessSetData was not called earlier, NULL will be returned.
+ *
+ * @param plugin a pointer to the plugin
+ * @retval a pointer to the data
+ */
+void * elektraPluginProcessGetData (Plugin * handle)
+{
+	ElektraPluginProcess * pp = elektraPluginGetData (handle);
+	if (pp)
+	{
+		return pp->pluginData;
+	}
+	return NULL;
+}

src/plugins/typechecker/Elektra/Typechecker.hs.in

@@ -5,6 +5,7 @@ import Elektra.Key
 import Elektra.KeySet
 import Elektra.KDB
 import Elektra.Plugin
+import Elektra.PluginProcess
 import Elektra.Ease
 import Elektra.Invoke
 import Elektra.SpecTranslator
@@ -41,6 +42,7 @@ typecheck p ks k c = withGlobalLogging (LogConfig Nothing ("@ENABLE_LOGGER@" ==
     metakeys <- keyListMeta dk
     forM_ metakeys (logDebugT . show)
 
+  logDebugT "getting config"
   conf <- elektraPluginGetConfig p
   logDebugT $ "the configuration is " ++ show conf
 
@@ -101,7 +103,7 @@ typecheck p ks k c = withGlobalLogging (LogConfig Nothing ("@ENABLE_LOGGER@" ==
     readPrelude p name location = do
       prelude <- ksNew 0
       baseKey <- keyNewWithValue (name ++ "/elektra/spec/") location
-      ini <- elektraPluginGetData p
+      ini <- elektraPluginProcessGetData p
       -- the handle is set otherwise opening the plugin would fail already
       -- likewise we could assume the data is set as well and use fromJust, but lets stay functional
       maybe (ksNew 0) (\i -> elektraInvoke2Args i "get" prelude baseKey >> ksDup prelude) ini
@@ -133,12 +135,12 @@ logDebugT = logDebug . T.pack
 openIni :: Plugin -> Key -> IO PluginStatus
 openIni p k = do
   logDebugT "Opening ini"
-  elektraInvokeOpen "ini" Nothing (Just k) >>= ifHandle (return Error) (\i -> elektraPluginSetData p i >> return Success)
+  elektraInvokeOpen "ini" Nothing (Just k) >>= ifHandle (return Error) (\i -> elektraPluginProcessSetData p i >> return Success)
 
 closeIni :: Plugin -> Key -> IO PluginStatus
 closeIni p k = do
   logDebugT "Closing ini"
-  elektraPluginGetData p >>= maybe (return Success) closeHandle
+  elektraPluginProcessGetData p >>= maybe (return Success) closeHandle
   where
     closeHandle = ifHandle (return Success) (\i -> elektraInvokeClose i (Just k) >> return Success)