Functions to deal with registration of IO functions

git-svn-id: http://svn.cactuscode.org/flesh/trunk@259 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 394 insertions, 0 deletions

diff --git a/src/IO/IOMethods.c b/src/IO/IOMethods.c
new file mode 100644
index 00000000..fe7c21e7
--- /dev/null
+++ b/src/IO/IOMethods.c
@@ -0,0 +1,394 @@
+ /*@@
+   @file      IOMethods.c
+   @date      Mon Jan 8 1999
+   @author    Gabrielle Allen
+   @desc 
+   Functions to deal with IO registration
+   @enddesc 
+ @@*/
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "flesh.h"
+#include "IOMethods.h"
+#include "StoreHandledData.h"
+
+static char *rcsid = "$Header$";
+
+
+/* Local data holding info on IO methods.*/
+
+static cHandledData *IOMethods = NULL;
+static int num_methods = 0;
+
+/* The GH extension structure.
+ * This contains pointers to functions which the extension requires.
+ *
+ * To add a new function, you must:
+ *
+ *  a) Add it to this structure
+ *  b) Initialise it to NULL in CCTK_RegisterGHExtension
+ *  c) Check its value in CheckAllExtensionsSetup
+ *  d) Provide a dummy function for CheckAllExtensionsSetup to use
+ *  e) Provide a registration function.
+ *  f) Add a prototype for the registration function to GHExtensions.h
+ */
+
+
+
+/* Function which checks that all the functions on all extensions have been 
+ * filled in.
+ */
+static int CheckAllMethodsSetup(void);
+
+/* Dummy function prototypes. */
+
+static int DummyOutputGH(cGH *GH);
+static int DummyOutputVarAs(cGH *GH, 
+                            const char *var, 
+                            const char *alias);
+
+
+/**************************************************************************
+ **************************************************************************
+ **************************************************************************/
+
+
+ /*@@
+   @routine    CCTK_RegisterIOMethod
+   @date       Wed Feb  3 13:33:09 1999
+   @author     Tom Goodale
+   @desc 
+   Registers a new IO method.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+int CCTK_RegisterIOMethod(const char *name)
+{
+  int return_val;
+
+  int handle;
+
+  struct IOMethod *new_method;
+
+  /* Check that the method hasn't already been registered */
+  handle = CCTK_GetHandle(IOMethods, name, NULL);
+
+  if(handle < 0)
+  {
+    /* New extension. */
+    new_method = (struct IOMethod *)malloc(sizeof(struct IOMethod));
+
+    if(new_method)
+    {
+      /* Get a handle for it. */
+      handle = CCTK_NewHandle(&IOMethods, name, new_method);
+
+      /* Initialise the IO method structure. */
+      new_method->OutputGH = DummyOutputGH;
+      new_method->OutputVarAs = DummyOutputVarAs;
+      
+      /* Remember how many methods there are */
+      num_methods++;
+    }
+    else
+    {
+      /* Memory failure. */
+      handle = -2;
+    }
+  }
+  else
+  {
+    /* Method already exists. */
+    handle = -1;
+  }
+    
+  return handle;
+}
+
+/***************************************************************************
+ *
+ *          Function Registration Routines.
+ *
+ ***************************************************************************/
+
+ /*@@
+   @routine    CCTK_RegisterIOMethodOutputGH
+   @date       Wed Feb  3 13:34:12 1999
+   @author     Tom Goodale
+   @desc 
+   Registers a function to register a routine for OutputGH.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+int CCTK_RegisterIOMethodOutputGH(int handle, int (*func)(cGH *))
+{
+  int return_code;
+  struct IOMethod *method;
+
+  /* Get the method. */
+  method = CCTK_GetHandledData(IOMethods, handle);
+
+  if(method)
+  {
+    method->OutputGH = func;
+    return_code = 1;
+  }
+  else
+  {
+    return_code = 0;
+  }
+
+  return return_code;
+  }
+
+ /*@@
+   @routine    CCTK_RegisterIOMethodOutputVar
+   @date       Wed Feb  3 13:33:36 1999
+   @author     Tom Goodale
+   @desc 
+   Registers a IO method OutputVarAs function.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+int CCTK_RegisterIOMethodOutputVarAs(int handle, int (*func)(cGH *, 
+                                    const char *,const char *))
+{
+  int return_code;
+  struct IOMethod *method;
+
+  /* Get the extension. */
+  method = CCTK_GetHandledData(IOMethods, handle);
+
+  if(method)
+  {
+    method->OutputVarAs = func;
+    return_code = 1;
+  }
+  else
+  {
+    return_code = 0;
+  }
+
+  return return_code;
+}
+
+
+/***************************************************************************
+ *
+ *          Function Calling Routines.
+ *
+ ***************************************************************************/
+
+ /*@@
+   @routine    CCTK_SetupGHExtensions
+   @date       Wed Feb  3 13:32:26 1999
+   @author     Tom Goodale
+   @desc 
+   Sets up all registered GH extensions on a GH.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+/*int CCTK_SetupGHExtensions(tFleshConfig *config, 
+			   int convergence_level, 
+			   cGH *GH)
+{
+  int return_code;
+  int handle;
+  struct GHExtension *extension;
+
+  if(CheckAllExtensionsSetup())
+  {
+  */  /* Create GHExtension array on the GH. */
+  /*GH->extensions = (void **)malloc(num_extensions*sizeof(void *));
+
+    if(GH->extensions)
+    {
+      for(handle = 0; handle < num_extensions; handle++)
+      {
+  *//* Call the SetupGH routines for each extension. */
+  /*extension =  (struct GHExtension *)CCTK_GetHandledData(GHExtensions, handle);
+	GH->extensions[handle] = extension->SetupGH(config, 
+						    convergence_level, 
+						    GH);
+      }
+      return_code = 0;
+    }
+    else
+    {
+      return_code = 1;
+    }
+  }
+  else
+  {
+    return_code = 2;
+  }
+  
+  return return_code;
+  }*/
+
+
+
+
+
+
+ /*@@
+   @routine    CCTK_InitGHExtensions
+   @date       Wed Feb  3 14:12:18 1999
+   @author     Tom Goodale
+   @desc 
+   Calls the initialisation routine for a GH extension.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+/*int CCTK_InitGHExtensions(cGH *GH)
+{
+  int handle;
+  struct GHExtension *extension;
+
+  for(handle = 0; handle < num_extensions; handle++)
+  {
+    extension =  (struct GHExtension *)CCTK_GetHandledData(GHExtensions, handle);
+    extension->InitGH(GH);
+  }
+
+  return 0;
+  }*/
+
+
+ /*@@
+   @routine    CCTK_rfrTraverseGHExtensions
+   @date       Wed Feb  3 14:16:17 1999
+   @author     Tom Goodale
+   @desc 
+   Calls the routines which an extension needs called at an rfr traversal.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+/*int CCTK_rfrTraverseGHExtensions(cGH *GH, int rfrpoint)
+{
+  int handle;
+  struct GHExtension *extension;
+
+  for(handle = 0; handle < num_extensions; handle++)
+  {
+    extension =  (struct GHExtension *)CCTK_GetHandledData(GHExtensions, handle);
+    extension->rfrTraverseGH(GH, rfrpoint);
+  }
+
+  return 0;
+  }*/
+
+
+/************************************************************************
+ *
+ *  Dummy functions.  Registered if no real function registered.
+ *
+ ************************************************************************/
+
+
+ /*@@
+   @routine    DummyOutputGH
+   @date       Wed Feb  3 13:36:52 1999
+   @author     Tom Goodale
+   @desc 
+   Dummy for OutputGH functions.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+static int DummyOutputGH(cGH *GH)
+{
+  return 0;
+}
+
+
+ /*@@
+   @routine    DummyOutputVar
+   @date       Wed Feb  3 13:37:31 1999
+   @author     Tom Goodale
+   @desc 
+   Dummy for OutputVarAs functions.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+@@*/
+static int DummyOutputVarAs(cGH *GH, 
+                            const char *var, 
+                            const char *alias)
+{
+  return 0;
+}
+
+
+
+
+int CactusDefaultOutputGH(cGH *GH)
+{
+  int handle;
+  struct IOMethod *method;
+
+  printf("I'm in the default OutputGH routine\n");
+  
+  for (handle = 0;;handle++)
+  {
+    method = (struct IOMethod *)CCTK_GetHandledData(IOMethods, handle);
+    if (method)
+    {
+      method->OutputGH(GH);
+    }
+    else
+    {
+      return handle;
+    }
+  }
+}
+
+int CactusDefaultOutputVarAsByMethod(cGH *GH, 
+                             const char *var,   
+                             const char *method, 
+                             const char *alias)
+{
+  printf("I'm in the default OutputVarAsByMethod routine\n");
+  
+  return 0;
+}