[GNUnet-SVN] r3258 - GNUnet/src/include

[grothoff]

Author: grothoff
Date: 2006-08-19 15:33:59 -0700 (Sat, 19 Aug 2006)
New Revision: 3258

Added:
   GNUnet/src/include/gnunet_setup_lib.h
Log:
api

Added: GNUnet/src/include/gnunet_setup_lib.h
===================================================================
--- GNUnet/src/include/gnunet_setup_lib.h       2006-08-19 22:33:34 UTC (rev 
3257)
+++ GNUnet/src/include/gnunet_setup_lib.h       2006-08-19 22:33:59 UTC (rev 
3258)
@@ -0,0 +1,231 @@
+/*
+     This file is part of GNUnet.
+     (C) 2006 Christian Grothoff (and other contributing authors)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 2, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+     Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @file include/gnunet_setup_lib.h
+ * @brief public interface to libgnunetsetup
+ *  Note that this API has various special requirements on
+ *  clients using it:
+ *  <ul>
+ *  <li>libguile must be initialized by the main method of any
+ *     program using it
+ *  <li>the API does not support concurrent calls
+ *  <li>GNS_TreeChangeListener callbacks must not call back
+ *     into the API (in particular not unregister themselves)
+ *  <li>clients may only read the tree, not modify it
+ *  <li>values and visibility flags in the tree may change
+ *     whenever the underlying configuration changes;
+ *     clients must make sure that there are no concurrent
+ *     changes to the configuration when reading values from
+ *     the tree
+ *  </ul>
+ *
+ * @author Christian Grothoff
+ */
+
+#ifndef GNUNET_SETUP_LIB_H
+#define GNUNET_SETUP_LIB_H
+
+/**
+ * Types of nodes and values in the configuration tree.
+ */
+typedef enum {
+  GNS_Root     = 0,
+  GNS_Node     = 1,
+  GNS_Leaf     = 2,
+  GNS_KindMask = 3,
+  GNS_Boolean  = 4,
+  GNS_Float    = 8,
+  GNS_Double   = 16,
+  GNS_UInt64   = 32,
+  GNS_String   = 64,
+} GNS_Type;
+
+/**
+ * @brief configuration value 
+ *
+ * A configuration value does not only specify a value
+ * but also the legal range of values.
+ */
+typedef union {
+
+  struct { 
+    int val;
+
+    int def;
+  } Boolean;
+
+  struct {
+    float val;
+    float def;
+  } Float;
+
+  struct {
+    unsigned long long val;
+    unsigned long long min;
+    unsigned long long max;
+    unsigned long long def;
+  } UInt64;
+
+  struct {
+    double val;
+    double def;
+  } Double;
+
+  struct {
+    /**
+     * 0-terminated string, never NULL
+     */ 
+    char * val;
+    
+    char * def;
+
+    /**
+     * Set of legal values for "val", NULL termianted;
+     * if the set is empty (legalSet[0] == NULL), then
+     * any string maybe legal
+     */
+    char ** legalRange;
+
+  } String;
+
+} GNS_Value;
+
+/**
+ * @brief node in the configuration tree
+ *
+ * GNS clients may read this structure but must NEVER modify
+ * it.  Note that the structure may change whenever the
+ * configuration is changed (GNUnet's configuration manager
+ * will notify GNS and GNS will update the tree).  What
+ * may change are the concrete values and the visibility
+ * attribute, but not the overall tree structure.
+ */
+typedef struct GNS_Tree {
+  
+  /**
+   * Section for this node (maybe NULL)
+   */
+  char * section;
+
+  /**
+   * Option name for this node (maybe NULL)
+   */
+  char * option;
+
+  /**
+   * Description for this node (never NULL)
+   */
+  char * description;
+
+  /**
+   * Helptext for this node (never NULL)
+   */
+  char * help;
+
+  /**
+   * NULL-terminated list of subnodes (must be empty for
+   * nodes of type "leaf")
+   */
+  struct GNS_Tree ** children;
+
+  /**
+   * Is this node visible to the user at this point?
+   */
+  int visible;
+
+  /**
+   * Type of the node (bitmask).
+   */
+  GNS_Type type;
+
+  /**
+   * Value for this node (type of pointer is determined
+   * by the type field)
+   */ 
+  GNS_Value value;
+
+} GNS_Tree;
+
+/**
+ * @brief gnunet setup context
+ */
+struct GNS_Context;
+
+/**
+ * Start the setup process by loading a scheme file that
+ * contains the configuration specification. 
+ * 
+ * @param ectx for error reporting
+ * @param cfg configuration values that have a known initial value
+ * @param specification name of the guile file containing the spec
+ * @return NULL on error (i.e. specification file not found)
+ */
+struct GNS_Context *
+GNS_load_specification(struct GE_Context * ectx,
+                      struct GC_Configuration * cfg,
+                      const char * specification);
+
+/**
+ * Obtain the GNS_Tree from the GNS system.  The tree is only valid
+ * until GNS_free_specification is called.  Note that visibility and
+ * values in the tree may change whenever the configuration of the GNS
+ * context changes.
+ *
+ * @return NULL on error
+ */
+const struct GNS_Tree *
+GNS_get_tree(struct GNS_Context * ctx);
+
+/**
+ * Free resources associated with the GNS context.
+ */
+void 
+GNS_free_specification(struct GNS_Context * ctx);
+
+/**
+ * Callback that GNS will call whenever the GNS_Tree
+ * is changed.
+ *
+ * @param node the node that has changed
+ */
+typedef void (*GNS_TreeChangeListener)(const struct GNS_Tree * node,
+                                      void * cls);
+
+/**
+ * Register a tree change listener with GNS.
+ *
+ * @param listener callback to call whenever the tree changes
+ */
+void 
+GNS_register_tree_change_listener(struct GNS_Context * ctx,
+                                 GNS_TreeChangeListener listener,
+                                 void * ctx);
+
+/**
+ * Release a tree change listener from GNS (do not call the listener
+ * in the future for change events).
+ */
+void 
+GNS_unregister_tree_change_listener(struct GNS_Context * ctx,
+                                   GNS_TreeChangeListener listener,
+                                   void * ctx);
+
+#endif


Property changes on: GNUnet/src/include/gnunet_setup_lib.h
___________________________________________________________________
Name: svn:eol-style
   + native