src/include/gnunet_monkey_edb.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file include/gnunet_monkey_edb.h
  23  * @brief Monkey API for accessing the Expression Database (edb)
  24  */
  25
  26 #ifndef GNUNET_MONKEY_EDB_H
  27 #define GNUNET_MONKEY_EDB_H
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #if 0                           /* keep Emacsens' auto-indent happy */
  33 }
  34 #endif
  35 #endif
  36
  37
  38 struct GNUNET_MONKEY_EDB_Context;
  39
  40 /**
  41  * Establish a connection to the Expression Database
  42  *
  43  * @param db_file_name path the Expression Database file
  44  * @return context to use for Accessing the Expression Database, NULL on error
  45  */
  46 struct GNUNET_MONKEY_EDB_Context *GNUNET_MONKEY_EDB_connect (const char
  47                                                              *db_file_name);
  48
  49
  50 /**
  51  * Disconnect from Database, and cleanup resources
  52  *
  53  * @param cfg configuration to use (used to know the path of the .db file).
  54  * @param service service that *this* process is implementing/providing, can be NULL
  55  * @return GNUNET_OK on success, GNUNET_NO on failure
  56  */
  57 int GNUNET_MONKEY_EDB_disconnect (struct GNUNET_MONKEY_EDB_Context *context);
  58
  59
  60 typedef int (*GNUNET_MONKEY_ExpressionIterator)(void *cls, const char *expression, int begin_line);
  61
  62
  63 /**
  64  * Update the context with a list of expressions.
  65  * The list is the initializations of sub-expressions
  66  * of the expression pointed to by start_line_no and end_line_no
  67  * For example, consider the following code snippet:
  68  * {
  69  *   struct Something whole; // line no.1
  70  *   struct SomethingElse part; // line no.2
  71  *   whole.part = &part; // line no.3
  72  *   whole.part->member = 1; // line no.4
  73  * }
  74  * If the expression supplied to the function is that of line no.4 "whole.part->member = 1;"
  75  * The returned list of expressions will be: whole.part = part (line no.3),
  76  * struct SomethingElse part (line no.2), and struct Something whole (line no.1),
  77  * which are the initialization expressions of the building components of the expression in question
  78  *
  79  * @param context the returned expessions will be available in it.
  80  * expression_list_head, and expression_list_tail must be null,
  81  * otherwise GNUNET_NO will be returned
  82  * @param file_name path to the file in which the expression in question exists
  83  * @param start_line_no expression beginning line
  84  * @param end_line_no expression end line
  85  * @param iter callback function, iterator for expressions returned from the Database
  86  * @param iter_cls closure for the expression iterator
  87  * @return GNUNET_OK success, GNUNET_NO failure
  88  */
  89 int
  90 GNUNET_MONKEY_EDB_get_expressions (struct GNUNET_MONKEY_EDB_Context *context,
  91                                    const char *file_name, int start_line_no,
  92                                    int end_line_no,
  93                                    GNUNET_MONKEY_ExpressionIterator iter, void *iter_cls);
  94
  95
  96
  97 #if 0                           /* keep Emacsens' auto-indent happy */
  98 {
  99 #endif
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif
 105