db.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  $RCSfile$
00003  -------------------
00004  cvs         : $Id$
00005  begin       : Tue Sep 09 2003
00006  copyright   : (C) 2003 by Martin Preuss
00007  email       : martin@libchipcard.de
00008 
00009  ***************************************************************************
00010  *                                                                         *
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU Lesser General Public            *
00013  *   License as published by the Free Software Foundation; either          *
00014  *   version 2.1 of the License, or (at your option) any later version.    *
00015  *                                                                         *
00016  *   This library is distributed in the hope that it will be useful,       *
00017  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00018  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00019  *   Lesser General Public License for more details.                       *
00020  *                                                                         *
00021  *   You should have received a copy of the GNU Lesser General Public      *
00022  *   License along with this library; if not, write to the Free Software   *
00023  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
00024  *   MA  02111-1307  USA                                                   *
00025  *                                                                         *
00026  ***************************************************************************/
00027 
00028 
00031 #ifndef GWENHYWFAR_DB_H
00032 #define GWENHYWFAR_DB_H
00033 
00034 #include <gwenhywfar/gwenhywfarapi.h>
00035 #include <gwenhywfar/path.h>
00036 #include <gwenhywfar/fastbuffer.h>
00037 #include <gwenhywfar/types.h>
00038 #include <stdio.h>
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 
00105 #define GWEN_DB_LINE_MAXSIZE  1024
00106 
00122 #define GWEN_DB_FLAGS_ALLOW_EMPTY_STREAM     0x00008000
00123 
00124 #define GWEN_DB_FLAGS_OVERWRITE_VARS         0x00010000
00125 
00126 #define GWEN_DB_FLAGS_OVERWRITE_GROUPS       0x00020000
00127 
00128 #define GWEN_DB_FLAGS_QUOTE_VARNAMES         0x00040000
00129 
00130 #define GWEN_DB_FLAGS_QUOTE_VALUES           0x00080000
00131 
00132 #define GWEN_DB_FLAGS_WRITE_SUBGROUPS        0x00100000
00133 
00134 #define GWEN_DB_FLAGS_DETAILED_GROUPS        0x00200000
00135 
00137 #define GWEN_DB_FLAGS_INDEND                 0x00400000
00138 
00140 #define GWEN_DB_FLAGS_ADD_GROUP_NEWLINES     0x00800000
00141 
00143 #define GWEN_DB_FLAGS_USE_COLON              0x01000000
00144 
00145 #define GWEN_DB_FLAGS_UNTIL_EMPTY_LINE       0x02000000
00146 
00148 #define GWEN_DB_FLAGS_OMIT_TYPES             0x04000000
00149 
00150 #define GWEN_DB_FLAGS_APPEND_FILE            0x08000000
00151 
00152 #define GWEN_DB_FLAGS_ESCAPE_CHARVALUES      0x10000000
00153 
00155 #define GWEN_DB_FLAGS_UNESCAPE_CHARVALUES    0x10000000
00156 
00158 #define GWEN_DB_FLAGS_LOCKFILE               0x20000000
00159 
00163 #define GWEN_DB_FLAGS_INSERT                 0x40000000
00164 
00168 #define GWEN_DB_FLAGS_DOSMODE                0x80000000
00169 
00171 #define GWEN_DB_FLAGS_DEFAULT \
00172   (\
00173   GWEN_DB_FLAGS_QUOTE_VALUES | \
00174   GWEN_DB_FLAGS_WRITE_SUBGROUPS | \
00175   GWEN_DB_FLAGS_DETAILED_GROUPS | \
00176   GWEN_DB_FLAGS_INDEND | \
00177   GWEN_DB_FLAGS_ADD_GROUP_NEWLINES | \
00178   GWEN_DB_FLAGS_ESCAPE_CHARVALUES | \
00179   GWEN_DB_FLAGS_UNESCAPE_CHARVALUES\
00180   )
00181 
00182 
00185 #define GWEN_DB_FLAGS_COMPACT \
00186   (\
00187   GWEN_DB_FLAGS_QUOTE_VALUES | \
00188   GWEN_DB_FLAGS_WRITE_SUBGROUPS | \
00189   GWEN_DB_FLAGS_ESCAPE_CHARVALUES | \
00190   GWEN_DB_FLAGS_UNESCAPE_CHARVALUES\
00191   )
00192 
00196 #define GWEN_DB_FLAGS_HTTP \
00197   (\
00198   GWEN_DB_FLAGS_USE_COLON |\
00199   GWEN_DB_FLAGS_UNTIL_EMPTY_LINE |\
00200   GWEN_DB_FLAGS_OMIT_TYPES | \
00201   GWEN_DB_FLAGS_DOSMODE \
00202   )
00203 
00210 #define GWEN_DB_NODE_FLAGS_DIRTY                   0x00000001
00211 
00212 #define GWEN_DB_NODE_FLAGS_VOLATILE                0x00000002
00213 
00215 #define GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM  0x00000004
00216 
00219 #define GWEN_DB_DEFAULT_LOCK_TIMEOUT 1000
00220 
00221 
00229 typedef struct GWEN_DB_NODE GWEN_DB_NODE;
00230 
00234 typedef enum {
00236   GWEN_DB_NodeType_Unknown=-1,
00238   GWEN_DB_NodeType_Group=0,
00240   GWEN_DB_NodeType_Var,
00242   GWEN_DB_NodeType_ValueChar,
00244   GWEN_DB_NodeType_ValueInt,
00246   GWEN_DB_NodeType_ValueBin,
00248   GWEN_DB_NodeType_ValuePtr,
00250   GWEN_DB_NodeType_ValueLast
00251 } GWEN_DB_NODE_TYPE;
00252 
00253 
00254 
00259 
00266 GWENHYWFAR_API 
00267 GWEN_DB_NODE *GWEN_DB_Group_new(const char *name);
00268 
00274 GWENHYWFAR_API 
00275 void GWEN_DB_Group_free(GWEN_DB_NODE *n);
00276 
00277 
00284 GWENHYWFAR_API 
00285 GWEN_DB_NODE *GWEN_DB_Group_dup(const GWEN_DB_NODE *n);
00286 
00304 GWENHYWFAR_API 
00305 GWEN_DB_NODE *GWEN_DB_GetFirstGroup(GWEN_DB_NODE *n);
00306 
00329 GWENHYWFAR_API 
00330 GWEN_DB_NODE *GWEN_DB_GetNextGroup(GWEN_DB_NODE *n);
00331 
00332 
00344 GWENHYWFAR_API 
00345 GWEN_DB_NODE *GWEN_DB_FindFirstGroup(GWEN_DB_NODE *n, const char *name);
00346 
00365 GWENHYWFAR_API 
00366 GWEN_DB_NODE *GWEN_DB_FindNextGroup(GWEN_DB_NODE *n, const char *name);
00367 
00368 
00379 typedef void *(*GWEN_DB_NODES_CB)(GWEN_DB_NODE *node, void *user_data);
00380 
00397 GWENHYWFAR_API 
00398 void *GWEN_DB_Groups_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
00399                              void *user_data);
00400 
00404 GWENHYWFAR_API 
00405 unsigned int GWEN_DB_Groups_Count(const GWEN_DB_NODE *node);
00463 GWENHYWFAR_API 
00464 const char *GWEN_DB_GetCharValue(GWEN_DB_NODE *n,
00465                                  const char *path,
00466                                  int idx,
00467                                  const char *defVal);
00476 GWENHYWFAR_API 
00477 int GWEN_DB_SetCharValue(GWEN_DB_NODE *n,
00478                          uint32_t flags,
00479                          const char *path,
00480                          const char *val);
00481 
00482 
00493 GWENHYWFAR_API 
00494 int GWEN_DB_AddCharValue(GWEN_DB_NODE *n,
00495                          const char *path,
00496                          const char *val,
00497                          int senseCase,
00498                          int check);
00499 
00500 
00510 GWENHYWFAR_API 
00511 int GWEN_DB_RemoveCharValue(GWEN_DB_NODE *n,
00512                             const char *path,
00513                             const char *val,
00514                             int senseCase);
00515 
00516 
00524 GWENHYWFAR_API 
00525 int GWEN_DB_GetIntValue(GWEN_DB_NODE *n,
00526                         const char *path,
00527                         int idx,
00528                         int defVal);
00529 
00538 GWENHYWFAR_API 
00539 int GWEN_DB_SetIntValue(GWEN_DB_NODE *n,
00540                         uint32_t flags,
00541                         const char *path,
00542                         int val);
00543 
00544 
00556 GWENHYWFAR_API 
00557 const void *GWEN_DB_GetBinValue(GWEN_DB_NODE *n,
00558                                 const char *path,
00559                                 int idx,
00560                                 const void *defVal,
00561                                 unsigned int defValSize,
00562                                 unsigned int *returnValueSize);
00563 
00574 GWENHYWFAR_API 
00575 int GWEN_DB_SetBinValue(GWEN_DB_NODE *n,
00576                         uint32_t flags,
00577                         const char *path,
00578                         const void *val,
00579                         unsigned int valSize);
00580 
00581 
00589 GWENHYWFAR_API
00590 void *GWEN_DB_GetPtrValue(GWEN_DB_NODE *n,
00591                           const char *path,
00592                           int idx,
00593                           void *defVal);
00594 
00604 GWENHYWFAR_API
00605 int GWEN_DB_SetPtrValue(GWEN_DB_NODE *n,
00606                         uint32_t flags,
00607                         const char *path,
00608                         void *val);
00617 
00627 GWENHYWFAR_API 
00628 GWEN_DB_NODE *GWEN_DB_GetGroup(GWEN_DB_NODE *n,
00629                                uint32_t flags,
00630                                const char *path);
00631 
00635 GWENHYWFAR_API 
00636 const char *GWEN_DB_GroupName(GWEN_DB_NODE *n);
00637 
00643 GWENHYWFAR_API 
00644 void GWEN_DB_GroupRename(GWEN_DB_NODE *n, const char *newname);
00645 
00660 GWENHYWFAR_API 
00661 int GWEN_DB_AddGroup(GWEN_DB_NODE *parent, GWEN_DB_NODE *node);
00662 
00678 GWENHYWFAR_API 
00679 int GWEN_DB_InsertGroup(GWEN_DB_NODE *parent, GWEN_DB_NODE *node);
00680 
00690 GWENHYWFAR_API 
00691 int GWEN_DB_AddGroupChildren(GWEN_DB_NODE *n, GWEN_DB_NODE *nn);
00692 
00702 GWENHYWFAR_API 
00703 void GWEN_DB_UnlinkGroup(GWEN_DB_NODE *n);
00704 
00711 GWENHYWFAR_API 
00712 int GWEN_DB_DeleteGroup(GWEN_DB_NODE *n,
00713                         const char *path);
00721 GWENHYWFAR_API 
00722 int GWEN_DB_ClearGroup(GWEN_DB_NODE *n,
00723                        const char *path);
00724 
00731 GWENHYWFAR_API 
00732 int GWEN_DB_IsGroup(const GWEN_DB_NODE *n);
00733 
00745 GWENHYWFAR_API 
00746   uint32_t GWEN_DB_GetNodeFlags(const GWEN_DB_NODE *n);
00747 
00753 GWENHYWFAR_API 
00754   void GWEN_DB_SetNodeFlags(GWEN_DB_NODE *n,
00755                             uint32_t flags);
00756 
00765 GWENHYWFAR_API 
00766 void GWEN_DB_ModifyBranchFlagsUp(GWEN_DB_NODE *n,
00767                                  uint32_t newflags,
00768                                  uint32_t mask);
00769 
00778 GWENHYWFAR_API 
00779 void GWEN_DB_ModifyBranchFlagsDown(GWEN_DB_NODE *n,
00780                                    uint32_t newflags,
00781                                    uint32_t mask);
00782 
00796 
00797 GWENHYWFAR_API 
00798 int GWEN_DB_ReadFromFastBuffer(GWEN_DB_NODE *n,
00799                                GWEN_FAST_BUFFER *fb,
00800                                uint32_t dbflags);
00801 
00811 GWENHYWFAR_API 
00812 int GWEN_DB_ReadFromIo(GWEN_DB_NODE *n,
00813                        GWEN_IO_LAYER *io,
00814                        uint32_t dbflags,
00815                        uint32_t guiid,
00816                        int msecs);
00817 
00818 GWENHYWFAR_API 
00819 int GWEN_DB_ReadFromFd(GWEN_DB_NODE *n,
00820                        int fd,
00821                        uint32_t dbflags,
00822                        uint32_t guiid,
00823                        int msecs);
00824 
00825 GWENHYWFAR_API 
00826 int GWEN_DB_ReadFile(GWEN_DB_NODE *n,
00827                      const char *fname,
00828                      uint32_t dbflags,
00829                      uint32_t guiid,
00830                      int msecs);
00831 
00832 GWENHYWFAR_API
00833 int GWEN_DB_ReadFromString(GWEN_DB_NODE *n,
00834                            const char *str,
00835                            int len,
00836                            uint32_t dbflags,
00837                            uint32_t guiid,
00838                            int msecs);
00839 
00840 GWENHYWFAR_API
00841 int GWEN_DB_WriteToFastBuffer(GWEN_DB_NODE *node,
00842                               GWEN_FAST_BUFFER *fb,
00843                               uint32_t dbflags);
00844 
00845 
00846 GWENHYWFAR_API 
00847 int GWEN_DB_WriteToIo(GWEN_DB_NODE *node,
00848                       GWEN_IO_LAYER *io,
00849                       uint32_t dbflags,
00850                       uint32_t guiid,
00851                       int msecs);
00852 
00853 GWENHYWFAR_API 
00854 int GWEN_DB_WriteFile(GWEN_DB_NODE *n,
00855                       const char *fname,
00856                       uint32_t dbflags,
00857                       uint32_t guiid,
00858                       int msecs);
00859 
00860 GWENHYWFAR_API 
00861 int GWEN_DB_WriteToFd(GWEN_DB_NODE *n, int fd, uint32_t dbflags, uint32_t guiid, int msecs);
00862 
00863 
00864 GWENHYWFAR_API 
00865 int GWEN_DB_WriteToBuffer(GWEN_DB_NODE *n,
00866                           GWEN_BUFFER *buf,
00867                           uint32_t dbflags,
00868                           uint32_t guiid,
00869                           int msecs);
00870 
00881 GWENHYWFAR_API 
00882 int GWEN_DB_ReadFileAs(GWEN_DB_NODE *n,
00883                        const char *fname,
00884                        const char *type,
00885                        GWEN_DB_NODE *params,
00886                        uint32_t dbflags,
00887                        uint32_t guiid,
00888                        int msecs);
00889 
00900 GWENHYWFAR_API 
00901 int GWEN_DB_WriteFileAs(GWEN_DB_NODE *n,
00902                         const char *fname,
00903                         const char *type,
00904                         GWEN_DB_NODE *params,
00905                         uint32_t dbflags,
00906                         uint32_t guiid,
00907                         int msecs);
00908 
00909 
00922 GWENHYWFAR_API 
00923 GWEN_DB_NODE *GWEN_DB_GetFirstVar(GWEN_DB_NODE *n);
00924 
00925 
00947 GWENHYWFAR_API 
00948 GWEN_DB_NODE *GWEN_DB_GetNextVar(GWEN_DB_NODE *n);
00949 
00954 GWENHYWFAR_API 
00955 const char *GWEN_DB_VariableName(GWEN_DB_NODE *n);
00956 
00957 
00958 GWENHYWFAR_API 
00959 void GWEN_DB_VariableRename(GWEN_DB_NODE *n, const char *newname);
00960 
00977 GWENHYWFAR_API 
00978 void *GWEN_DB_Variables_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
00979                                 void *user_data);
00980 
00985 GWENHYWFAR_API 
00986 unsigned int GWEN_DB_Variables_Count(const GWEN_DB_NODE *node);
00987     
00993 GWENHYWFAR_API 
00994 GWEN_DB_NODE_TYPE GWEN_DB_GetVariableType(GWEN_DB_NODE *n,
00995                                           const char *p);
00996 
01003 GWENHYWFAR_API 
01004 int GWEN_DB_DeleteVar(GWEN_DB_NODE *n,
01005                       const char *path);
01006 
01013 GWENHYWFAR_API 
01014 int GWEN_DB_VariableExists(GWEN_DB_NODE *n,
01015                            const char *path);
01016 
01024 GWENHYWFAR_API
01025   int GWEN_DB_ValueExists(GWEN_DB_NODE *n,
01026                           const char *path,
01027                           unsigned int idx);
01028 
01035 GWENHYWFAR_API 
01036 int GWEN_DB_IsVariable(const GWEN_DB_NODE *n);
01037 
01038 
01050 GWENHYWFAR_API 
01051 GWEN_DB_NODE *GWEN_DB_FindFirstVar(GWEN_DB_NODE *n, const char *name);
01052 
01071 GWENHYWFAR_API 
01072 GWEN_DB_NODE *GWEN_DB_FindNextVar(GWEN_DB_NODE *n, const char *name);
01073 
01086 GWENHYWFAR_API 
01087 GWEN_DB_NODE *GWEN_DB_GetFirstValue(GWEN_DB_NODE *n);
01088 
01105 GWENHYWFAR_API 
01106 GWEN_DB_NODE *GWEN_DB_GetNextValue(GWEN_DB_NODE *n);
01107 
01124 GWENHYWFAR_API 
01125 void *GWEN_DB_Values_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
01126                              void *user_data);
01127 
01131 GWENHYWFAR_API 
01132 unsigned int GWEN_DB_Values_Count(const GWEN_DB_NODE *node);
01133 
01138 GWENHYWFAR_API 
01139 GWEN_DB_NODE_TYPE GWEN_DB_GetValueType(GWEN_DB_NODE *n);
01140 
01141 GWENHYWFAR_API
01142 GWEN_DB_NODE_TYPE GWEN_DB_GetValueTypeByPath(GWEN_DB_NODE *n,
01143                                              const char *p,
01144                                              unsigned int i);
01145 
01150 GWENHYWFAR_API
01151 const char *GWEN_DB_GetCharValueFromNode(const GWEN_DB_NODE *n);
01152 
01157 GWENHYWFAR_API
01158 int GWEN_DB_SetCharValueInNode(GWEN_DB_NODE *n, const char *s);
01159 
01160 GWENHYWFAR_API
01161 int GWEN_DB_GetIntValueFromNode(const GWEN_DB_NODE *n);
01162 
01163 GWENHYWFAR_API
01164 const void *GWEN_DB_GetBinValueFromNode(const GWEN_DB_NODE *n,
01165                                         unsigned int *size);
01166 
01167 
01174 GWENHYWFAR_API 
01175 int GWEN_DB_IsValue(const GWEN_DB_NODE *n);
01189 
01196 GWENHYWFAR_API 
01197 void GWEN_DB_Dump(GWEN_DB_NODE *n, FILE *f, int insert);
01202 
01203 
01204 #ifdef __cplusplus
01205 }
01206 #endif
01207 
01208 
01209 #endif
01210 
01211 
01212 

Generated on Mon Jan 25 12:56:01 2010 for gwenhywfar by  doxygen 1.5.6