/usr/include/gwenhywfar4/gwenhywfar/db.h is in libgwenhywfar-core-dev 4.20.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 | /***************************************************************************
begin : Tue Sep 09 2003
copyright : (C) 2003-2010 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
* *
***************************************************************************/
/** @file db.h */
#ifndef GWENHYWFAR_DB_H
#define GWENHYWFAR_DB_H
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/path.h>
#include <gwenhywfar/fastbuffer.h>
#include <gwenhywfar/types.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @defgroup MOD_DB Database
* @ingroup MOD_PARSER
*
* @brief This group contains the definition of a GWEN_DB database.
*
* A GWEN_DB database consists of a tree of @ref GWEN_DB_NODE entries.
* Such a @ref GWEN_DB_NODE node can either be a group node, or a
* variable node, or a value node. Usually an application programmer
* will only get in touch with group nodes. The application programmer
* can iterate through the group nodes with GWEN_DB_GetGroup(),
* GWEN_DB_Groups_foreach(), and can retrieve variable values with
* GWEN_DB_GetIntValue(), GWEN_DB_GetCharValue() and so on.
*
* <p>
* The following graph shows the internal structure of a GWEN_DB: <br>
* @image html db2.png "Internal structure of a GWEN_DB"
* <br>
* As you can see the GWEN_DB consists of multiple units called NODE. Every
* node has a pointer to:
* <ul>
* <li>its parent</li>
* <li>its first child (only the <strong>first</strong>)</li>
* <li>its successor (but not its predecessor!)
* </ul>
* Such a node can be either of the following:
* <ul>
* <li>a group containing other groups and variables</li>
* <li>a variable containing values (and values only)</li>
* <li>a value containing its value data</li>
* </ul>
* </p>
*
* Each group has a name. Depending on the GWEN_DB_FLAGS given when
* reading a GWEN_DB from a file or creating it, it may very well be
* possible to have multiple groups with the same name as children of
* the same root node. Again: Child group nodes with the same name may
* very well exist. This also applies to variable nodes.
*
* For the interested reader, we again explain the difference of the
* three kinds of nodes. Depending on either of these cases, you can
*
* <ol>
* <li> Iterate through groups or get a variable with
* e.g. GWEN_DB_GetNextGroup(), GWEN_DB_GetNextVar()
* <li> Get the type of a variable with e.g. GWEN_DB_GetVariableType()
* -- the value of a variable is retrieved by the shortcut functions
* explained below.
* <li> Get the type of a value with GWEN_DB_GetValueType(). Again the
* value itself is retrieved with the shortcut functions below.
* </ol>
*
* To retrieve or set the value of such a variable, the following
* "shortcut" functions for all three supported typed exist:
* GWEN_DB_GetIntValue(), GWEN_DB_GetCharValue(),
* GWEN_DB_GetBinValue(). These functions only accept a group and a "path"
* to the desired variable.
*
*/
/*@{*/
/** maximum size of a text line when reading/writing from/to streams */
#define GWEN_DB_LINE_MAXSIZE 1024
/** @name DB Flags
*
* <p>
* Please note that the setter functions also take the flags from
* the module @ref MOD_PATH (e.g. @ref GWEN_PATH_FLAGS_PATHMUSTEXIST)
* into account. So you most likely need to specify
* them, too.
* </p>
* <p>
* However, for your conveniance there is a default flag value which suffices
* in most cases (@ref GWEN_DB_FLAGS_DEFAULT).
* </p>
*/
/*@{*/
/** when reading a DB allow for empty streams (e.g. empty file) */
#define GWEN_DB_FLAGS_ALLOW_EMPTY_STREAM 0x00008000
/** Overwrite existing values when assigning a new value to a variable */
#define GWEN_DB_FLAGS_OVERWRITE_VARS 0x00010000
/** Overwrite existing groups when calling @ref GWEN_DB_GetGroup() */
#define GWEN_DB_FLAGS_OVERWRITE_GROUPS 0x00020000
/** quote variable names when writing them to a stream */
#define GWEN_DB_FLAGS_QUOTE_VARNAMES 0x00040000
/** quote values when writing them to a stream */
#define GWEN_DB_FLAGS_QUOTE_VALUES 0x00080000
/** allows writing of subgroups when writing to a stream */
#define GWEN_DB_FLAGS_WRITE_SUBGROUPS 0x00100000
/** adds some comments when writing to a stream */
#define GWEN_DB_FLAGS_DETAILED_GROUPS 0x00200000
/** indents text according to the current path depth when writing to a
* stream to improve the readability of the created file */
#define GWEN_DB_FLAGS_INDEND 0x00400000
/** writes a newline to the stream after writing a group to improve
* the readability of the created file */
#define GWEN_DB_FLAGS_ADD_GROUP_NEWLINES 0x00800000
/** uses a colon (":") instead of an equation mark when reading/writing
* variable definitions */
#define GWEN_DB_FLAGS_USE_COLON 0x01000000
/** stops reading from a stream at empty lines */
#define GWEN_DB_FLAGS_UNTIL_EMPTY_LINE 0x02000000
/** normally the type of a variable is written to the stream, too.
* This flag changes this behaviour */
#define GWEN_DB_FLAGS_OMIT_TYPES 0x04000000
/** appends data to an existing file instead of overwriting it */
#define GWEN_DB_FLAGS_APPEND_FILE 0x08000000
/** Char values are escaped when writing them to a file. */
#define GWEN_DB_FLAGS_ESCAPE_CHARVALUES 0x10000000
/** Char values are unescaped when reading them from a file (uses the same
* bit @ref GWEN_DB_FLAGS_ESCAPE_CHARVALUES uses) */
#define GWEN_DB_FLAGS_UNESCAPE_CHARVALUES 0x10000000
/** locks a file before reading from or writing to it
* This is used by @ref GWEN_DB_ReadFile and @ref GWEN_DB_WriteFile */
#define GWEN_DB_FLAGS_LOCKFILE 0x20000000
/**
* When setting a value or getting a group insert newly created
* values/groups rather than appending them.*/
#define GWEN_DB_FLAGS_INSERT 0x40000000
/**
* When writing a DB use DOS line termination (e.g. CR/LF) instead if unix mode (LF only)
*/
#define GWEN_DB_FLAGS_DOSMODE 0x80000000
/** These are the default flags which you use in most cases */
#define GWEN_DB_FLAGS_DEFAULT \
(\
GWEN_DB_FLAGS_QUOTE_VALUES | \
GWEN_DB_FLAGS_WRITE_SUBGROUPS | \
GWEN_DB_FLAGS_DETAILED_GROUPS | \
GWEN_DB_FLAGS_INDEND | \
GWEN_DB_FLAGS_ADD_GROUP_NEWLINES | \
GWEN_DB_FLAGS_ESCAPE_CHARVALUES | \
GWEN_DB_FLAGS_UNESCAPE_CHARVALUES\
)
/** same like @ref GWEN_DB_FLAGS_DEFAULT except that the produced file
* (when writing to a stream) is more compact (but less readable)*/
#define GWEN_DB_FLAGS_COMPACT \
(\
GWEN_DB_FLAGS_QUOTE_VALUES | \
GWEN_DB_FLAGS_WRITE_SUBGROUPS | \
GWEN_DB_FLAGS_ESCAPE_CHARVALUES | \
GWEN_DB_FLAGS_UNESCAPE_CHARVALUES\
)
/** These flags can be used to read a DB from a HTTP header. It uses a
* colon instead of the equation mark with variable definitions and stops
* when encountering an empty line.*/
#define GWEN_DB_FLAGS_HTTP \
(\
GWEN_DB_FLAGS_USE_COLON |\
GWEN_DB_FLAGS_UNTIL_EMPTY_LINE |\
GWEN_DB_FLAGS_OMIT_TYPES | \
GWEN_DB_FLAGS_DOSMODE \
)
/*@}*/
/** @name Node Flags
*/
/*@{*/
/** is set then this node has been altered */
#define GWEN_DB_NODE_FLAGS_DIRTY 0x00000001
/** variable is volatile (will not be written) */
#define GWEN_DB_NODE_FLAGS_VOLATILE 0x00000002
/** this is only valid for groups. It determines whether subgroups will
* inherit the hash mechanism set in the root node. */
#define GWEN_DB_NODE_FLAGS_INHERIT_HASH_MECHANISM 0x00000004
/** node has to be disposed of safely (i.e. it will be overridden before freeing it) */
#define GWEN_DB_NODE_FLAGS_SAFE 0x00000008
/*@}*/
#define GWEN_DB_DEFAULT_LOCK_TIMEOUT 1000
/**
* This is the type used to store a DB. Its contents are explicitly NOT
* part of the API.
*
* A description of what can be done with this type can be found in
* @ref db.h
*/
typedef struct GWEN_DB_NODE GWEN_DB_NODE;
/**
* This specifies the type of a value stored in the DB.
*/
typedef enum {
/** type unknown */
GWEN_DB_NodeType_Unknown=-1,
/** group */
GWEN_DB_NodeType_Group=0,
/** variable */
GWEN_DB_NodeType_Var,
/** simple, null terminated C-string */
GWEN_DB_NodeType_ValueChar,
/** integer */
GWEN_DB_NodeType_ValueInt,
/** binary, user defined data */
GWEN_DB_NodeType_ValueBin,
/** pointer , will not be stored or read to/from files */
GWEN_DB_NodeType_ValuePtr,
/** last value type */
GWEN_DB_NodeType_ValueLast
} GWEN_DB_NODE_TYPE;
/** @name Constructing, Destructing, Copying
*
*/
/*@{*/
/**
* Creates a new (empty) group with the given name. I.e. this is the
* constructor. When finished using this group, you should free it
* using @ref GWEN_DB_Group_free() in order to avoid memory leaks.
* @param name name of the group to create
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_Group_new(const char *name);
/**
* Frees a DB group. I.e. this is the destructor. This is needed to
* avoid memory leaks.
* @param n db node
*/
GWENHYWFAR_API
void GWEN_DB_Group_free(GWEN_DB_NODE *n);
/**
* Creates a deep copy of the given node. This copy will then be owned
* by the caller and MUST be freed after using it by calling @ref
* GWEN_DB_Group_free().
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_Group_dup(const GWEN_DB_NODE *n);
/*@}*/
/** @name Iterating Through Groups
*
*/
/*@{*/
/**
* Returns the first group node below the given one.
*
* If there is no group node then NULL is returned. This can either
* mean that this node does not have any children or the only
* children are variables instead of groups.
*
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetFirstGroup(GWEN_DB_NODE *n);
/**
* Returns the next group node following the given one, which has the
* same parent node.
*
* This function works absolutely independently of the group nodes'
* names -- the returned node may or may not have the same name as the
* specified node. The only guarantee is that the returned node will
* be a group node.
*
* If there is no group node then NULL is returned. This can either
* mean that the parent node does not have any further
* children, or that the other children are variables instead
* of groups.
*
* @note This is one of the few functions where the returned node is @e not
* the child of the specified node, but instead it is the next node
* with the same parent node. In other words, this function is an
* exception. In most other functions the returned node is a child of
* the specified node.
*
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetNextGroup(GWEN_DB_NODE *n);
/**
* Returns the first group node below the given one by name.
*
* If there is no matching group node then NULL is returned. This can either
* mean that this node does not have any children or the only
* children are variables instead of groups or their is no group of the
* given name.
*
* @param n db node
* @param name name to look for (joker and wildcards allowed)
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_FindFirstGroup(GWEN_DB_NODE *n, const char *name);
/**
* Returns the next group node following the given one, which has the
* same parent node, by name.
*
* If there is no matching group node then NULL is returned. This can either
* mean that the parent node does not have any further
* children, or that the other children are variables instead
* of groups or that there is no group with the given name.
*
* @note This is one of the few functions where the returned node is @e not
* the child of the specified node, but instead it is the next node
* with the same parent node. In other words, this function is an
* exception. In most other functions the returned node is a child of
* the specified node.
*
* @param n db node
* @param name name to look for (joker and wildcards allowed)
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_FindNextGroup(GWEN_DB_NODE *n, const char *name);
/** Callback function type for GWEN_DB_Groups_Foreach(),
* GWEN_DB_Variables_Foreach(), and GWEN_DB_Values_Foreach().
*
* @param node The current node element
*
* @param user_data The arbitrary data passed to the foreach function.
*
* @return NULL if the iteration should continue, or non-NULL if the
* iteration should stop and that value be returned.
*/
typedef void *(*GWEN_DB_NODES_CB)(GWEN_DB_NODE *node, void *user_data);
/** Iterates through all group nodes that are @e direct children
* of the given node, calling the callback function 'func' on each
* group node. Traversal will stop when 'func' returns a non-NULL
* value, and the routine will return with that value. Otherwise the
* routine will return NULL.
*
* If no nodes that are groups are found as children, then
* this function will simply do nothing.
*
* @param node The group node whose children shall be iterated through.
* @param func The function to be called with each group node.
* @param user_data A pointer passed on to the function 'func'.
* @return The non-NULL pointer returned by 'func' as soon as it
* returns one. Otherwise (i.e. 'func' always returns NULL)
* returns NULL.
* @author Christian Stimming <stimming@tuhh.de> */
GWENHYWFAR_API
void *GWEN_DB_Groups_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
void *user_data);
/** Returns the number of group nodes that are @e direct children of
* the given node. In other words, this is the number of group nodes
* that will be reached in the GWEN_DB_Groups_foreach() function. */
GWENHYWFAR_API
unsigned int GWEN_DB_Groups_Count(const GWEN_DB_NODE *node);
/**
* Returns the parent group of the given node.
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetParentGroup(GWEN_DB_NODE *n);
/*@}*/
/** @name Variable Getter and Setter
*
* These getter functions check for the existence of the given variable and
* return the value specified by an index.
* Under the following circumstances the also given default value will be
* returned:
* <ul>
* <li>the variable does not exist</li>
* <li>the variable exists but has no values (should not occur)</li>
* <li>the variable exists but the given value index is out of range (e.g.
* specifying index 1 with a variable that has only one value)</li>
* <li>a string value is expected but the variable is not of that type.
* However, if you want an integer value but the variable only has a char
* value then the getter functions try to convert the char to an integer.
* Other conversions do not take place.</li>
* </ul>
*
* The setter functions either replace an existing variable, create a missing
* variable, add a value or return an error if the variable does not exist
* (see description of the flags).
* All setter functions make deep copies of the given values, so you may
* free the params after calling the setter function.
*
* All getter functions return a const pointer to the variable's retrieved
* value.
* All setter functions return Zero if ok and Nonzero on error.
*
* This module knows about the following types (see @ref GWEN_DB_VALUETYPE):
* <ul>
* <li>char (simple null terminated C strings)</li>
* <li>int (integer values)</li>
* <li>bin (binary, user specified data)</li>
* </ul>
*
* @note The value returned by a getter function is only valid as long as the
* corresponding variable (node) exists.<br>
* So if you retrieve the value of a variable and delete the variable (or even
* the whole DB) afterwards the pointer becomes invalid and using it will most
* likely crash your program.<br>
* If you want to use such a value even after the corresponding variable
* has been deleted you need to make a copy.
*
*/
/*@{*/
/**
* Returns the variable's retrieved value.
* @param n db node
* @param path path and name of the variable
* @param idx index number of the value to return
* @param defVal default value to return in case there is no real value
*/
GWENHYWFAR_API
const char *GWEN_DB_GetCharValue(GWEN_DB_NODE *n,
const char *path,
int idx,
const char *defVal);
/**
* @return 0 on success, nonzero on error
* @param n db node
* @param flags see @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others which
* can all be OR-combined to form the flags to use.
* @param path path and name of the variable
* @param val The string value that is copied into the DB
*/
GWENHYWFAR_API
int GWEN_DB_SetCharValue(GWEN_DB_NODE *n,
uint32_t flags,
const char *path,
const char *val);
/**
* Adds the given char value to the given variable if it not already exists
* (depending on the arguments senseCase and check).
* @return 0 on success, nonzero on error
* @param n db node
* @param path path and name of the variable
* @param val The string value that is copied into the DB
* @param senseCase if 0 then the case of the value is ignored while checking
* @param check if 1 then the variable will be checked for this value
*/
GWENHYWFAR_API
int GWEN_DB_AddCharValue(GWEN_DB_NODE *n,
const char *path,
const char *val,
int senseCase,
int check);
/**
* Removes the given char value from the given variable if it exists
* (depending on the arguments senseCase and check).
* @return 0 on success, nonzero on error
* @param n db node
* @param path path and name of the variable
* @param val The string value to be removed
* @param senseCase if 0 then the case of the value is ignored while checking
*/
GWENHYWFAR_API
int GWEN_DB_RemoveCharValue(GWEN_DB_NODE *n,
const char *path,
const char *val,
int senseCase);
/**
* Returns the variable's retrieved value.
* @param n db node
* @param path path and name of the variable
* @param idx index number of the value to return
* @param defVal default value to return in case there is no real value
*/
GWENHYWFAR_API
int GWEN_DB_GetIntValue(GWEN_DB_NODE *n,
const char *path,
int idx,
int defVal);
/**
* @return 0 on success, nonzero on error
* @param n db node
* @param flags see @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others which
* can all be OR-combined to form the flags to use.
* @param path path and name of the variable
* @param val new value
*/
GWENHYWFAR_API
int GWEN_DB_SetIntValue(GWEN_DB_NODE *n,
uint32_t flags,
const char *path,
int val);
/**
* Returns the variable's retrieved value. The size of the binary
* data is written into the int pointer argument returnValueSize.
* @param n db node
* @param path path and name of the variable
* @param idx index number of the value to return
* @param defVal default value to return in case there is no real value
* @param defValSize size of the default value
* @param returnValueSize pointer to a variable to receive the length
* of the data returned
*/
GWENHYWFAR_API
const void *GWEN_DB_GetBinValue(GWEN_DB_NODE *n,
const char *path,
int idx,
const void *defVal,
unsigned int defValSize,
unsigned int *returnValueSize);
/**
* @param n db node
* @param path path and name of the variable
* @param flags see @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others which
* can all be OR-combined to form the flags to use.
* @param val The binary data that is copied into the DB.
* @param valSize The number of bytes in the binary data value.
*
* @return 0 on success, nonzero on error
*/
GWENHYWFAR_API
int GWEN_DB_SetBinValue(GWEN_DB_NODE *n,
uint32_t flags,
const char *path,
const void *val,
unsigned int valSize);
/**
* Returns the variable's retrieved value.
* @param n db node
* @param path path and name of the variable
* @param idx index number of the value to return
* @param defVal default value to return in case there is no real value
*/
GWENHYWFAR_API
void *GWEN_DB_GetPtrValue(GWEN_DB_NODE *n,
const char *path,
int idx,
void *defVal);
/**
* @param n db node
* @param path path and name of the variable
* @param flags see @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others which
* can all be OR-combined to form the flags to use.
* @param val The pointer that is stored within the DB.
*
* @return 0 on success, nonzero on error
*/
GWENHYWFAR_API
int GWEN_DB_SetPtrValue(GWEN_DB_NODE *n,
uint32_t flags,
const char *path,
void *val);
/*@}*/
/** @name Group Handling
*
*/
/*@{*/
/**
* This function either creates a new group, returns an existing one or
* returns an error if there is no group but the caller wanted one (depending
* on the flags given).
* @param n db node
* @param flags see @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others which
* can all be OR-combined to form the flags to use.
* @param path path and name of the group to be created/located
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetGroup(GWEN_DB_NODE *n,
uint32_t flags,
const char *path);
/**
* Returns the name of the given group.
*/
GWENHYWFAR_API
const char *GWEN_DB_GroupName(GWEN_DB_NODE *n);
/**
* Renames the given group.
* @param n db node
* @param newname new name for the group
*/
GWENHYWFAR_API
void GWEN_DB_GroupRename(GWEN_DB_NODE *n, const char *newname);
/**
* Adds the given group node as a new child of the given parent group node.
*
* The group name has no influence on what will happen in this
* function. In other words, if the parent group already has a child
* group with the same name as 'node', then after this function two
* child group nodes with the same name will exist.
*
* @note This function takes over the ownership of the new group, so
* you MUST NOT free it afterwards.
*
* @param parent Some group node that will be the parent of the added node
* @param node Group node to add
*/
GWENHYWFAR_API
int GWEN_DB_AddGroup(GWEN_DB_NODE *parent, GWEN_DB_NODE *node);
/**
* Adds the given group node as the new first child of the given parent group
* node.
*
* The group name has no influence on what will happen in this
* function. In other words, if the parent group already has a child
* group with the same name as 'node', then after this function two
* child group nodes with the same name will exist.
*
* @note This function takes over the ownership of the new group, so
* you MUST NOT free it afterwards.
*
* @param parent Some group node that will be the parent of the added node
* @param node Group node to add
*/
GWENHYWFAR_API
int GWEN_DB_InsertGroup(GWEN_DB_NODE *parent, GWEN_DB_NODE *node);
/**
* This function adds all children of the second node as new children to
* the first given one.
*
* @note This function does NOT take over ownership of the new
* group. The caller is still the owner of the given group.
* @param n db node
* @param nn node whose children are to be added (makes deep copies)
*/
GWENHYWFAR_API
int GWEN_DB_AddGroupChildren(GWEN_DB_NODE *n, GWEN_DB_NODE *nn);
/**
* Unlinks a group (and thereby all its children) from its parent and
* brothers.
*
* This function DOES NOT free the group, it just unlinks it. You can then use
* it with e.g. @ref GWEN_DB_AddGroup or other functions to relink it at any
* other position of even in other DBs.
* @param n db node
*/
GWENHYWFAR_API
void GWEN_DB_UnlinkGroup(GWEN_DB_NODE *n);
/**
* Locates and removes the group of the given name.
* @return 0 on success, nonzero on error
* @param n db node
* @param path path to the group to delete
*/
GWENHYWFAR_API
int GWEN_DB_DeleteGroup(GWEN_DB_NODE *n,
const char *path);
/**
* Frees all children of the given node thereby clearing it.
* @return 0 on success, nonzero on error
* @param n db node
* @param path path to the group under the given node to clear
* (if 0 then clear the given node)
*/
GWENHYWFAR_API
int GWEN_DB_ClearGroup(GWEN_DB_NODE *n,
const char *path);
/** Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given
* NODE is a Group or not. Usually these group nodes are the only
* nodes that the application gets in touch with.
*
* @param n db node
*/
GWENHYWFAR_API
int GWEN_DB_IsGroup(const GWEN_DB_NODE *n);
/**
* Returns the node flags for the given db node.
* Please note that all modifications applied to a node will set the
* dirty flag in the node itself and all its parents.
* This allows to use this funcion here to check whether a DB has been
* modified.
* @return current node flags for this node (see
* @ref GWEN_DB_NODE_FLAGS_DIRTY)
*
* @param n db node
*/
GWENHYWFAR_API
uint32_t GWEN_DB_GetNodeFlags(const GWEN_DB_NODE *n);
/**
* Modifies the node flags for the given db node
* @param n db node
* @param flags flags to set (see @ref GWEN_DB_NODE_FLAGS_DIRTY)
*/
GWENHYWFAR_API
void GWEN_DB_SetNodeFlags(GWEN_DB_NODE *n,
uint32_t flags);
/**
* Modifies the flags of the given node and all its parents according
* to the parameters given.
* @param n db node
* @param newflags new flags to set (see @ref GWEN_DB_NODE_FLAGS_DIRTY)
* @param mask only those flags which are set in this mask are modified
* according to newflags
*/
GWENHYWFAR_API
void GWEN_DB_ModifyBranchFlagsUp(GWEN_DB_NODE *n,
uint32_t newflags,
uint32_t mask);
/**
* Modifies the flags of the given node and all its children according
* to the parameters given.
* @param n db node
* @param newflags new flags to set (see @ref GWEN_DB_NODE_FLAGS_DIRTY)
* @param mask only those flags which are set in this mask are modified
* according to newflags
*/
GWENHYWFAR_API
void GWEN_DB_ModifyBranchFlagsDown(GWEN_DB_NODE *n,
uint32_t newflags,
uint32_t mask);
/*@}*/
/** @name Reading and Writing From/To IO Layers
*
* These functions read or write a DB from/to GWEN_IO_LAYER.
* This allows to use any source or target supported by GWEN_IO_LAYER
* for data storage (these are currently sockets, files and memory buffers).
* The flags determine how to read/write the data (e.g. if sub-groups are
* to be written etc).
*/
/*@{*/
GWENHYWFAR_API
int GWEN_DB_ReadFromFastBuffer(GWEN_DB_NODE *n,
GWEN_FAST_BUFFER *fb,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_ReadFromIo(GWEN_DB_NODE *n, GWEN_SYNCIO *sio, uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_ReadFile(GWEN_DB_NODE *n,
const char *fname,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_ReadFromString(GWEN_DB_NODE *n,
const char *str,
int len,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_WriteToFastBuffer(GWEN_DB_NODE *node,
GWEN_FAST_BUFFER *fb,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_WriteToIo(GWEN_DB_NODE *node,
GWEN_SYNCIO *sio,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_WriteFile(GWEN_DB_NODE *n,
const char *fname,
uint32_t dbflags);
GWENHYWFAR_API
int GWEN_DB_WriteToBuffer(GWEN_DB_NODE *n,
GWEN_BUFFER *buf,
uint32_t dbflags);
/**
* Imports a file into a DB using a GWEN_DBIO importer.
* @param n node to read into (becomes the root of the imported data)
* @param fname name of the file to import
* @param type GWEN_DBIO type
* @param params parameters for the GWEN_DBIO importer (content depends on
* the importer, may even be NULL for some types)
* @param dbflags flags to use while importing (see
* @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others)
*/
GWENHYWFAR_API
int GWEN_DB_ReadFileAs(GWEN_DB_NODE *n,
const char *fname,
const char *type,
GWEN_DB_NODE *params,
uint32_t dbflags);
/**
* Exports a DB to a file using a GWEN_DBIO exporter.
* @param n node to write
* @param fname name of the file to export to
* @param type GWEN_DBIO type
* @param params parameters for the GWEN_DBIO exporter (content depends on
* the exporter, may even be NULL for some types)
* @param dbflags flags to use while exporting (see
* @ref GWEN_DB_FLAGS_OVERWRITE_VARS and others)
*/
GWENHYWFAR_API
int GWEN_DB_WriteFileAs(GWEN_DB_NODE *n,
const char *fname,
const char *type,
GWEN_DB_NODE *params,
uint32_t dbflags);
/*@}*/
/** @name Iterating Through Variables and variable handling
*
*/
/*@{*/
/**
* Returns the first variable below the given group.
* If there is no variable then NULL is returned.
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetFirstVar(GWEN_DB_NODE *n);
/**
* Returns the next variable node following the given one, which has
* the same parent node.
*
* This function works absolutely independently of the variable nodes'
* names -- the returned node may or may not have the same name as the
* specified node. The only guarantee is that the returned node will
* be a variable node.
*
* If there is no variable node then NULL is returned. This can either
* mean that the parent node does not have any further children, or
* that the other children are groups instead of variables.
*
* @note This is the only function where the returned node is @e not
* the child of the specified node, but instead it is the next node
* with the same parent node. In other words, this function is an
* exception. In all other functions the returned node is a child of
* the specified node.
*
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetNextVar(GWEN_DB_NODE *n);
/**
* Returns the name of the variable specified by the given node.
* @param n db node specifying a variable (not a group !)
*/
GWENHYWFAR_API
const char *GWEN_DB_VariableName(GWEN_DB_NODE *n);
GWENHYWFAR_API
void GWEN_DB_VariableRename(GWEN_DB_NODE *n, const char *newname);
/** Iterates through all variable nodes that are @e direct children
* of the given node, calling the callback function 'func' on each
* variable node. Traversal will stop when 'func' returns a non-NULL
* value, and the routine will return with that value. Otherwise the
* routine will return NULL.
*
* If no nodes that are variables are found as children, then
* this function will simply do nothing.
*
* @param node The group node whose children shall be iterated through.
* @param func The function to be called with each group node.
* @param user_data A pointer passed on to the function 'func'.
* @return The non-NULL pointer returned by 'func' as soon as it
* returns one. Otherwise (i.e. 'func' always returns NULL)
* returns NULL.
* @author Christian Stimming <stimming@tuhh.de> */
GWENHYWFAR_API
void *GWEN_DB_Variables_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
void *user_data);
/** Returns the number of variable nodes that are @e direct children
* of the given node. In other words, this is the number of variable
* nodes that will be reached in the GWEN_DB_Variables_Foreach()
* function. */
GWENHYWFAR_API
unsigned int GWEN_DB_Variables_Count(const GWEN_DB_NODE *node);
/**
* Returns the type of the first value of the given variable
* @param n root node of the DB
* @param p path of the variable to inspect
*/
GWENHYWFAR_API
GWEN_DB_NODE_TYPE GWEN_DB_GetVariableType(GWEN_DB_NODE *n,
const char *p);
/**
* Deletes the given variable by removing it and its values from the DB.
* @param n root of the DB
* @param path path to the variable to remove
* @return Zero on success, nonzero on error
*/
GWENHYWFAR_API
int GWEN_DB_DeleteVar(GWEN_DB_NODE *n,
const char *path);
/**
* Checks whether the given variable exists.
* @return Zero if variable not found, nonzero otherwise
* @param n root of the DB
* @param path path to the variable to check for
*/
GWENHYWFAR_API
int GWEN_DB_VariableExists(GWEN_DB_NODE *n,
const char *path);
/**
* Checks whether the given variable and value exists.
* @return Zero if variable not found, nonzero otherwise
* @param n root of the DB
* @param path path to the variable to check for
* @param idx index number of the variable's value to check for
*/
GWENHYWFAR_API
int GWEN_DB_ValueExists(GWEN_DB_NODE *n,
const char *path,
unsigned int idx);
/** Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given
* NODE is a Variable or not. Usually the Application does not get in
* touch with such Nodes but only with nodes that are Groups.
*
* @param n db node
*/
GWENHYWFAR_API
int GWEN_DB_IsVariable(const GWEN_DB_NODE *n);
/**
* Returns the first variable node below the given one by name.
*
* If there is no matching variable node then NULL is returned. This can
* either mean that this node does not have any children or the only
* children are groups/values instead of variables or their is no variable of
* the given name.
*
* @param n db node
* @param name name to look for (joker and wildcards allowed)
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_FindFirstVar(GWEN_DB_NODE *n, const char *name);
/**
* Returns the next variable node following the given one, which has the
* same parent node, by name.
*
* If there is no matching variable node then NULL is returned. This can
* either mean that this node does not have any children or the only
* children are groups/values instead of variables or their is no variable of
* the given name.
*
* @note This is one of the few functions where the returned node is @e not
* the child of the specified node, but instead it is the next node
* with the same parent node. In other words, this function is an
* exception. In most other functions the returned node is a child of
* the specified node.
*
* @param n db node
* @param name name to look for (joker and wildcards allowed)
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_FindNextVar(GWEN_DB_NODE *n, const char *name);
/*@}*/
/** @name Iterating Through Values and value handling
*
*/
/*@{*/
/**
* Returns the first value below the given variable.
* If there is no value then NULL is returned.
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetFirstValue(GWEN_DB_NODE *n);
/**
* Returns the next value node following the given one, which has the
* same parent node.
*
* If there is no value node then NULL is returned. This can either
* mean that the parent node does not have any further children, or
* that the other children aren't values.
*
* @note This is the only function where the returned node is @e not
* the child of the specified node, but instead it is the next node
* with the same parent node. In other words, this function is an
* exception. In all other functions the returned node is a child of
* the specified node.
*
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE *GWEN_DB_GetNextValue(GWEN_DB_NODE *n);
/** Iterates through all value nodes that are @e direct children
* of the given node, calling the callback function 'func' on each
* value node. Traversal will stop when 'func' returns a non-NULL
* value, and the routine will return with that value. Otherwise the
* routine will return NULL.
*
* If no nodes that are values are found as children, then
* this function will simply do nothing.
*
* @param node The variable node whose children shall be iterated through.
* @param func The function to be called with each group node.
* @param user_data A pointer passed on to the function 'func'.
* @return The non-NULL pointer returned by 'func' as soon as it
* returns one. Otherwise (i.e. 'func' always returns NULL)
* returns NULL.
* @author Christian Stimming <stimming@tuhh.de> */
GWENHYWFAR_API
void *GWEN_DB_Values_Foreach(GWEN_DB_NODE *node, GWEN_DB_NODES_CB func,
void *user_data);
/** Returns the number of value nodes that are @e direct children of
* the given node. In other words, this is the number of value nodes
* that will be reached in the GWEN_DB_Values_foreach() function. */
GWENHYWFAR_API
unsigned int GWEN_DB_Values_Count(const GWEN_DB_NODE *node);
/**
* Returns the type of the given value.
* @param n db node
*/
GWENHYWFAR_API
GWEN_DB_NODE_TYPE GWEN_DB_GetValueType(GWEN_DB_NODE *n);
GWENHYWFAR_API
GWEN_DB_NODE_TYPE GWEN_DB_GetValueTypeByPath(GWEN_DB_NODE *n,
const char *p,
unsigned int i);
/**
* Returns the value data of the given value node.
* If the given node is not a char-value node then 0 is returned.
*/
GWENHYWFAR_API
const char *GWEN_DB_GetCharValueFromNode(const GWEN_DB_NODE *n);
/**
* Replaces the current value data of the given node by the new string.
* @return 0 if ok, error code otherwise
*/
GWENHYWFAR_API
int GWEN_DB_SetCharValueInNode(GWEN_DB_NODE *n, const char *s);
GWENHYWFAR_API
int GWEN_DB_GetIntValueFromNode(const GWEN_DB_NODE *n);
GWENHYWFAR_API
const void *GWEN_DB_GetBinValueFromNode(const GWEN_DB_NODE *n,
unsigned int *size);
/** Predicate: Returns nonzero (TRUE) or zero (FALSE) if the given
* NODE is a Value or not. Usually the Application does not get in
* touch with such Nodes but only with nodes that are Groups.
*
* @param n db node
*/
GWENHYWFAR_API
int GWEN_DB_IsValue(const GWEN_DB_NODE *n);
/*@}*/
/** @name Debugging
*
* These functions are for debugging purposes only. You should NOT consider
* them part of the API.
*/
/*@{*/
/**
* Dumps the content of the given DB to the given file (e.g. stderr).
* @param n node to dump
* @param insert number of blanks to insert at every line
*/
GWENHYWFAR_API
void GWEN_DB_Dump(GWEN_DB_NODE *n, int insert);
/*@}*/
/*@}*/
#ifdef __cplusplus
}
#endif
#endif
|