concord.h

   1 /* Copyright (C) 2003, 2004, 2005, 2006, 2013 MORIOKA Tomohiko
   2    This file is part of the CONCORD Library.
   3
   4    The CONCORD Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The CONCORD Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the CONCORD Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 #ifndef _CONCORD_H
  20 #define _CONCORD_H
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25 #if 0
  26 }
  27 #endif
  28
  29 #include <db.h>
  30 #include <cos.h>
  31
  32 typedef DBT CONCORD_String_Tank;
  33 typedef CONCORD_String_Tank* CONCORD_String;
  34
  35 int CONCORD_String_size (const CONCORD_String s);
  36 unsigned char* CONCORD_String_data (const CONCORD_String s);
  37
  38
  39 typedef COS_Object CONCORD_Object;
  40
  41 typedef enum CONCORD_Backend_Type
  42 {
  43   CONCORD_Backend_NONE,
  44   CONCORD_Backend_Berkeley_DB
  45 } CONCORD_Backend_Type;
  46
  47
  48 typedef struct COS_DS_ent COS_DS_ent;
  49 typedef COS_DS_ent* COS_DS;
  50 typedef COS_DS CONCORD_DS;
  51
  52 CONCORD_DS
  53 concord_open_ds (CONCORD_Backend_Type type, const char* location,
  54                  int subtype, int modemask);
  55
  56 COS_DS concord_open_env (COS_object ds);
  57
  58 int concord_close_ds (CONCORD_DS ds);
  59
  60 char* concord_ds_location (CONCORD_DS ds);
  61
  62 int
  63 concord_ds_set_object_failure (CONCORD_DS ds, CONCORD_Object object_nil);
  64 int
  65 concord_ds_set_read_object_function (CONCORD_DS ds,
  66                                      CONCORD_Object (*read_object)
  67                                      (const unsigned char* str,
  68                                       size_t length));
  69
  70 int
  71 concord_ds_foreach_genre_name (CONCORD_DS ds,
  72                                int (*func) (CONCORD_DS ds, char* name));
  73
  74
  75 typedef struct COS_Genre_ent COS_Genre_ent;
  76 typedef COS_Genre_ent* COS_Genre;
  77 typedef COS_Genre CONCORD_Genre;
  78
  79 CONCORD_Genre
  80 concord_ds_get_genre (CONCORD_DS ds, const char* name);
  81
  82 COS_Genre
  83 concord_get_genre (COS_object ds, COS_object genre);
  84
  85 char* concord_genre_get_name (CONCORD_Genre genre);
  86
  87 CONCORD_DS concord_genre_get_data_source (CONCORD_Genre genre);
  88
  89 int
  90 concord_genre_foreach_feature_name (CONCORD_Genre genre,
  91                                     int (*func) (CONCORD_Genre genre,
  92                                                  char* name));
  93
  94
  95 typedef struct COS_Feature_ent COS_Feature_ent;
  96 typedef COS_Feature_ent* COS_Feature;
  97 typedef COS_Feature CONCORD_Feature;
  98
  99 CONCORD_Feature
 100 concord_genre_get_feature (CONCORD_Genre genre, const char* name);
 101
 102 COS_Feature
 103 concord_get_feature (COS_object ds,
 104                      COS_object genre, COS_object feature);
 105
 106 char* concord_feature_get_name (CONCORD_Feature feature);
 107
 108 CONCORD_Genre concord_feature_get_genre (CONCORD_Feature feature);
 109
 110 int concord_feature_setup_db (CONCORD_Feature feature, int writable);
 111
 112 int concord_feature_sync (CONCORD_Feature feature);
 113
 114 int
 115 concord_obj_put_feature_value_str (const char* object_id,
 116                                    CONCORD_Feature feature,
 117                                    unsigned char* value);
 118
 119 CONCORD_Object
 120 concord_obj_get_feature_value (const char* object_id,
 121                                CONCORD_Feature feature);
 122 int
 123 concord_obj_get_feature_value_string (const char* object_id,
 124                                       CONCORD_Feature feature,
 125                                       CONCORD_String value);
 126 unsigned char*
 127 concord_obj_gets_feature_value (const char* object_id,
 128                                 CONCORD_Feature feature,
 129                                 unsigned char* dst, size_t size);
 130
 131 COS_object
 132 concord_object_get_feature_value (COS_object object, COS_object feature);
 133
 134 int
 135 concord_feature_foreach_obj_string (CONCORD_Feature feature,
 136                                     int (*func)
 137                                     (CONCORD_String object_id,
 138                                      CONCORD_Feature feature,
 139                                      CONCORD_String valdatum));
 140
 141
 142 typedef struct COS_Feature_INDEX_ent COS_Feature_INDEX_ent;
 143 typedef COS_Feature_INDEX_ent* COS_Feature_INDEX;
 144 typedef COS_Feature_INDEX CONCORD_INDEX;
 145
 146 CONCORD_INDEX
 147 concord_genre_get_index (CONCORD_Genre genre, const char* name);
 148
 149 COS_Feature_INDEX
 150 concord_get_feature_index (COS_object ds,
 151                            COS_object genre, COS_object feature);
 152
 153 char* concord_index_get_name (CONCORD_INDEX index);
 154
 155 CONCORD_Genre concord_index_get_genre (CONCORD_INDEX index);
 156
 157 int concord_index_setup_db (CONCORD_INDEX index, int writable);
 158
 159 int concord_index_sync (CONCORD_INDEX index);
 160
 161 int concord_index_strid_put_obj (CONCORD_INDEX index,
 162                                  const char* strid,
 163                                  char* object_id);
 164
 165 int concord_index_strid_get_obj_string (CONCORD_INDEX index,
 166                                         const char* strid,
 167                                         CONCORD_String object_id);
 168
 169
 170 COS_object
 171 concord_decode_object (COS_object ds, COS_object genre,
 172                        COS_object feature, COS_object id);
 173
 174 #if 0
 175 {
 176 #endif
 177 #ifdef __cplusplus
 178 }
 179 #endif
 180
 181 #endif /* !_CONCORD_H */