/usr/include/kclangc.h is in libkyotocabinet-dev 1.2.76-4.2+b1.
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 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 | /*************************************************************************************************
* C language binding
* Copyright (C) 2009-2012 FAL Labs
* This file is part of Kyoto Cabinet.
* This program 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
* 3 of the License, or any later version.
* This program 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 this program.
* If not, see <http://www.gnu.org/licenses/>.
*************************************************************************************************/
#ifndef _KCLANGC_H /* duplication check */
#define _KCLANGC_H
#if defined(__cplusplus)
extern "C" {
#endif
#if !defined(__STDC_LIMIT_MACROS)
#define __STDC_LIMIT_MACROS 1 /**< enable limit macros for C++ */
#endif
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <float.h>
#include <limits.h>
#include <locale.h>
#include <math.h>
#include <setjmp.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <string.h>
#include <time.h>
#include <stdint.h>
/**
* C wrapper of polymorphic database.
*/
typedef struct {
void* db; /**< dummy member */
} KCDB;
/**
* C wrapper of polymorphic cursor.
*/
typedef struct {
void* cur; /**< dummy member */
} KCCUR;
/**
* Binary string of byte array.
*/
typedef struct {
char* buf; /**< pointer to the data region */
size_t size; /**< size of the data region */
} KCSTR;
/**
* Key-Value record.
*/
typedef struct {
KCSTR key; /**< key string */
KCSTR value; /**< value string */
} KCREC;
/**
* Error codes.
*/
enum {
KCESUCCESS, /**< success */
KCENOIMPL, /**< not implemented */
KCEINVALID, /**< invalid operation */
KCENOREPOS, /**< no repository */
KCENOPERM, /**< no permission */
KCEBROKEN, /**< broken file */
KCEDUPREC, /**< record duplication */
KCENOREC, /**< no record */
KCELOGIC, /**< logical inconsistency */
KCESYSTEM, /**< system error */
KCEMISC = 15 /**< miscellaneous error */
};
/**
* Open modes.
*/
enum {
KCOREADER = 1 << 0, /**< open as a reader */
KCOWRITER = 1 << 1, /**< open as a writer */
KCOCREATE = 1 << 2, /**< writer creating */
KCOTRUNCATE = 1 << 3, /**< writer truncating */
KCOAUTOTRAN = 1 << 4, /**< auto transaction */
KCOAUTOSYNC = 1 << 5, /**< auto synchronization */
KCONOLOCK = 1 << 6, /**< open without locking */
KCOTRYLOCK = 1 << 7, /**< lock without blocking */
KCONOREPAIR = 1 << 8 /**< open without auto repair */
};
/**
* Merge modes.
*/
enum {
KCMSET, /**< overwrite the existing value */
KCMADD, /**< keep the existing value */
KCMREPLACE, /**< modify the existing record only */
KCMAPPEND /**< append the new value */
};
/** The package version. */
extern const char* const KCVERSION;
/** Special pointer for no operation by the visiting function. */
extern const char* const KCVISNOP;
/** Special pointer to remove the record by the visiting function. */
extern const char* const KCVISREMOVE;
/**
* Call back function to visit a full record.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param opq an opaque pointer.
* @return If it is the pointer to a region, the value is replaced by the content. If it
* is KCVISNOP, nothing is modified. If it is KCVISREMOVE, the record is removed.
*/
typedef const char* (*KCVISITFULL)(const char* kbuf, size_t ksiz,
const char* vbuf, size_t vsiz, size_t* sp, void* opq);
/**
* Call back function to visit an empty record.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param opq an opaque pointer.
* @return If it is the pointer to a region, the value is replaced by the content. If it
* is KCVISNOP or KCVISREMOVE, nothing is modified.
*/
typedef const char* (*KCVISITEMPTY)(const char* kbuf, size_t ksiz, size_t* sp, void* opq);
/**
* Call back function to process the database file.
* @param path the path of the database file.
* @param count the number of records.
* @param size the size of the available region.
* @param opq an opaque pointer.
* @return true on success, or false on failure.
*/
typedef int32_t (*KCFILEPROC)(const char* path, int64_t count, int64_t size, void* opq);
/**
* Allocate a region on memory.
* @param size the size of the region.
* @return the pointer to the allocated region. The region of the return value should be
* released with the kcfree function when it is no longer in use.
*/
void* kcmalloc(size_t size);
/**
* Release a region allocated in the library.
* @param ptr the pointer to the region.
*/
void kcfree(void* ptr);
/**
* Get the time of day in seconds.
* @return the time of day in seconds. The accuracy is in microseconds.
*/
double kctime(void);
/**
* Convert a string to an integer.
* @param str specifies the string.
* @return the integer. If the string does not contain numeric expression, 0 is returned.
*/
int64_t kcatoi(const char* str);
/**
* Convert a string with a metric prefix to an integer.
* @param str the string, which can be trailed by a binary metric prefix. "K", "M", "G", "T",
* "P", and "E" are supported. They are case-insensitive.
* @return the integer. If the string does not contain numeric expression, 0 is returned. If
* the integer overflows the domain, INT64_MAX or INT64_MIN is returned according to the
* sign.
*/
int64_t kcatoix(const char* str);
/**
* Convert a string to a real number.
* @param str specifies the string.
* @return the real number. If the string does not contain numeric expression, 0.0 is
* returned.
*/
double kcatof(const char* str);
/**
* Get the hash value by MurMur hashing.
* @param buf the source buffer.
* @param size the size of the source buffer.
* @return the hash value.
*/
uint64_t kchashmurmur(const void* buf, size_t size);
/**
* Get the hash value by FNV hashing.
* @param buf the source buffer.
* @param size the size of the source buffer.
* @return the hash value.
*/
uint64_t kchashfnv(const void* buf, size_t size);
/**
* Calculate the levenshtein distance of two regions.
* @param abuf the pointer to the region of one buffer.
* @param asiz the size of the region of one buffer.
* @param bbuf the pointer to the region of the other buffer.
* @param bsiz the size of the region of the other buffer.
* @param utf flag to treat keys as UTF-8 strings.
* @return the levenshtein distance of two regions.
*/
size_t kclevdist(const void* abuf, size_t asiz, const void* bbuf, size_t bsiz, int32_t utf);
/**
* Get the quiet Not-a-Number value.
* @return the quiet Not-a-Number value.
*/
double kcnan();
/**
* Get the positive infinity value.
* @return the positive infinity value.
*/
double kcinf();
/**
* Check a number is a Not-a-Number value.
* @return true for the number is a Not-a-Number value, or false if not.
*/
int32_t kcchknan(double num);
/**
* Check a number is an infinity value.
* @return true for the number is an infinity value, or false if not.
*/
int32_t kcchkinf(double num);
/**
* Get the readable string of an error code.
* @param code the error code.
* @return the readable string of the error code.
*/
const char* kcecodename(int32_t code);
/**
* Create a polymorphic database object.
* @return the created database object.
* @note The object of the return value should be released with the kcdbdel function when it is
* no longer in use.
*/
KCDB* kcdbnew(void);
/**
* Destroy a database object.
* @param db the database object.
*/
void kcdbdel(KCDB* db);
/**
* Open a database file.
* @param db a database object.
* @param path the path of a database file. If it is "-", the database will be a prototype
* hash database. If it is "+", the database will be a prototype tree database. If it is ":",
* the database will be a stash database. If it is "*", the database will be a cache hash
* database. If it is "%", the database will be a cache tree database. If its suffix is
* ".kch", the database will be a file hash database. If its suffix is ".kct", the database
* will be a file tree database. If its suffix is ".kcd", the database will be a directory
* hash database. If its suffix is ".kcf", the database will be a directory tree database.
* If its suffix is ".kcx", the database will be a plain text database. Otherwise, this
* function fails. Tuning parameters can trail the name, separated by "#". Each parameter is
* composed of the name and the value, separated by "=". If the "type" parameter is specified,
* the database type is determined by the value in "-", "+", ":", "*", "%", "kch", "kct",
* "kcd", kcf", and "kcx". All database types support the logging parameters of "log",
* "logkinds", and "logpx". The prototype hash database and the prototype tree database do
* not support any other tuning parameter. The stash database supports "bnum". The cache
* hash database supports "opts", "bnum", "zcomp", "capcnt", "capsiz", and "zkey". The cache
* tree database supports all parameters of the cache hash database except for capacity
* limitation, and supports "psiz", "rcomp", "pccap" in addition. The file hash database
* supports "apow", "fpow", "opts", "bnum", "msiz", "dfunit", "zcomp", and "zkey". The file
* tree database supports all parameters of the file hash database and "psiz", "rcomp",
* "pccap" in addition. The directory hash database supports "opts", "zcomp", and "zkey".
* The directory tree database supports all parameters of the directory hash database and
* "psiz", "rcomp", "pccap" in addition. The plain text database does not support any other
* tuning parameter.
* @param mode the connection mode. KCOWRITER as a writer, KCOREADER as a reader.
* The following may be added to the writer mode by bitwise-or: KCOCREATE, which means
* it creates a new database if the file does not exist, KCOTRUNCATE, which means it
* creates a new database regardless if the file exists, KCOAUTOTRAN, which means each
* updating operation is performed in implicit transaction, KCOAUTOSYNC, which means
* each updating operation is followed by implicit synchronization with the file system. The
* following may be added to both of the reader mode and the writer mode by bitwise-or:
* KCONOLOCK, which means it opens the database file without file locking,
* KCOTRYLOCK, which means locking is performed without blocking, KCONOREPAIR, which
* means the database file is not repaired implicitly even if file destruction is detected.
* @return true on success, or false on failure.
* @note The tuning parameter "log" is for the original "tune_logger" and the value specifies
* the path of the log file, or "-" for the standard output, or "+" for the standard error.
* "logkinds" specifies kinds of logged messages and the value can be "debug", "info", "warn",
* or "error". "logpx" specifies the prefix of each log message. "opts" is for "tune_options"
* and the value can contain "s" for the small option, "l" for the linear option, and "c" for
* the compress option. "bnum" corresponds to "tune_bucket". "zcomp" is for "tune_compressor"
* and the value can be "zlib" for the ZLIB raw compressor, "def" for the ZLIB deflate
* compressor, "gz" for the ZLIB gzip compressor, "lzo" for the LZO compressor, "lzma" for the
* LZMA compressor, or "arc" for the Arcfour cipher. "zkey" specifies the cipher key of the
* compressor. "capcount" is for "cap_count". "capsize" is for "cap_size". "psiz" is for
* "tune_page". "rcomp" is for "tune_comparator" and the value can be "lex" for the lexical
* comparator or "dec" for the decimal comparator. "pccap" is for "tune_page_cache". "apow"
* is for "tune_alignment". "fpow" is for "tune_fbp". "msiz" is for "tune_map". "dfunit" is
* for "tune_defrag". Every opened database must be closed by the kcdbclose method when it is
* no longer in use. It is not allowed for two or more database objects in the same process to
* keep their connections to the same database file at the same time.
*/
int32_t kcdbopen(KCDB* db, const char* path, uint32_t mode);
/**
* Close the database file.
* @param db a database object.
* @return true on success, or false on failure.
*/
int32_t kcdbclose(KCDB* db);
/**
* Get the code of the last happened error.
* @param db a database object.
* @return the code of the last happened error.
*/
int32_t kcdbecode(KCDB* db);
/**
* Get the supplement message of the last happened error.
* @param db a database object.
* @return the supplement message of the last happened error.
*/
const char* kcdbemsg(KCDB* db);
/**
* Accept a visitor to a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param fullproc a call back function to visit a record.
* @param emptyproc a call back function to visit an empty record space.
* @param opq an opaque pointer to be given to the call back functions.
* @param writable true for writable operation, or false for read-only operation.
* @return true on success, or false on failure.
* @note The operation for each record is performed atomically and other threads accessing the
* same record are blocked. To avoid deadlock, any explicit database operation must not be
* performed in this function.
*/
int32_t kcdbaccept(KCDB* db, const char* kbuf, size_t ksiz,
KCVISITFULL fullproc, KCVISITEMPTY emptyproc, void* opq, int32_t writable);
/**
* Accept a visitor to multiple records at once.
* @param db a database object.
* @param keys specifies an array of binary strings of the keys.
* @param knum specifies the number of the keys.
* @param fullproc a call back function to visit a record.
* @param emptyproc a call back function to visit an empty record space.
* @param opq an opaque pointer to be given to the call back functions.
* @param writable true for writable operation, or false for read-only operation.
* @return true on success, or false on failure.
* @note The operations for specified records are performed atomically and other threads
* accessing the same records are blocked. To avoid deadlock, any explicit database operation
* must not be performed in this function.
*/
int32_t kcdbacceptbulk(KCDB* db, const KCSTR* keys, size_t knum,
KCVISITFULL fullproc, KCVISITEMPTY emptyproc,
void* opq, int32_t writable);
/**
* Iterate to accept a visitor for each record.
* @param db a database object.
* @param fullproc a call back function to visit a record.
* @param opq an opaque pointer to be given to the call back function.
* @param writable true for writable operation, or false for read-only operation.
* @return true on success, or false on failure.
* @note The whole iteration is performed atomically and other threads are blocked. To avoid
* deadlock, any explicit database operation must not be performed in this function.
*/
int32_t kcdbiterate(KCDB* db, KCVISITFULL fullproc, void* opq, int32_t writable);
/**
* Scan each record in parallel.
* @param db a database object.
* @param fullproc a call back function to visit a record.
* @param opq an opaque pointer to be given to the call back function.
* @param thnum the number of worker threads.
* @return true on success, or false on failure.
* @note This function is for reading records and not for updating ones. The return value of
* the visitor is just ignored. To avoid deadlock, any explicit database operation must not
* be performed in this function.
*/
int32_t kcdbscanpara(KCDB* db, KCVISITFULL fullproc, void* opq, size_t thnum);
/**
* Set the value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the value is overwritten.
*/
int32_t kcdbset(KCDB* db, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Add a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the record is not modified and false is returned.
*/
int32_t kcdbadd(KCDB* db, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Replace the value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, no new record is created and false is returned.
* If the corresponding record exists, the value is modified.
*/
int32_t kcdbreplace(KCDB* db, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Append the value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the given value is appended at the end of the existing value.
*/
int32_t kcdbappend(KCDB* db, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Add a number to the numeric value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param num the additional number.
* @param orig the origin number if no record corresponds to the key. If it is INT64_MIN and
* no record corresponds, this function fails. If it is INT64_MAX, the value is set as the
* additional number regardless of the current value.
* @return the result value, or INT64_MIN on failure.
* @note The value is serialized as an 8-byte binary integer in big-endian order, not a decimal
* string. If existing value is not 8-byte, this function fails.
*/
int64_t kcdbincrint(KCDB* db, const char* kbuf, size_t ksiz, int64_t num, int64_t orig);
/**
* Add a number to the numeric value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param num the additional number.
* @param orig the origin number if no record corresponds to the key. If it is negative
* infinity and no record corresponds, this function fails. If it is positive infinity, the
* value is set as the additional number regardless of the current value.
* @return the result value, or Not-a-number on failure.
* @note The value is serialized as an 16-byte binary fixed-point number in big-endian order,
* not a decimal string. If existing value is not 16-byte, this function fails.
*/
double kcdbincrdouble(KCDB* db, const char* kbuf, size_t ksiz, double num, double orig);
/**
* Perform compare-and-swap.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param ovbuf the pointer to the old value region. NULL means that no record corresponds.
* @param ovsiz the size of the old value region.
* @param nvbuf the pointer to the new value region. NULL means that the record is removed.
* @param nvsiz the size of new old value region.
* @return true on success, or false on failure.
*/
int32_t kcdbcas(KCDB* db, const char* kbuf, size_t ksiz,
const char* ovbuf, size_t ovsiz, const char* nvbuf, size_t nvsiz);
/**
* Remove a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, false is returned.
*/
int32_t kcdbremove(KCDB* db, const char* kbuf, size_t ksiz);
/**
* Retrieve the value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the corresponding record, or NULL on failure.
* @note If no record corresponds to the key, NULL is returned. Because an additional zero
* code is appended at the end of the region of the return value, the return value can be
* treated as a C-style string. The region of the return value should be released with the
* kcfree function when it is no longer in use.
*/
char* kcdbget(KCDB* db, const char* kbuf, size_t ksiz, size_t* sp);
/**
* Check the existence of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return the size of the value, or -1 on failure.
*/
int32_t kcdbcheck(KCDB* db, const char* kbuf, size_t ksiz);
/**
* Retrieve the value of a record.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the buffer into which the value of the corresponding record is
* written.
* @param max the size of the buffer.
* @return the size of the value, or -1 on failure.
*/
int32_t kcdbgetbuf(KCDB* db, const char* kbuf, size_t ksiz, char* vbuf, size_t max);
/**
* Retrieve the value of a record and remove it atomically.
* @param db a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the corresponding record, or NULL on failure.
* @note If no record corresponds to the key, NULL is returned. Because an additional zero
* code is appended at the end of the region of the return value, the return value can be
* treated as a C-style string. The region of the return value should be released with the
* kcfree function when it is no longer in use.
*/
char* kcdbseize(KCDB* db, const char* kbuf, size_t ksiz, size_t* sp);
/**
* Store records at once.
* @param db a database object.
* @param recs the records to store.
* @param rnum specifies the number of the records.
* @param atomic true to perform all operations atomically, or false for non-atomic operations.
* @return the number of stored records, or -1 on failure.
*/
int64_t kcdbsetbulk(KCDB* db, const KCREC* recs, size_t rnum, int32_t atomic);
/**
* Remove records at once.
* @param db a database object.
* @param keys the keys of the records to remove.
* @param knum specifies the number of the keys.
* @param atomic true to perform all operations atomically, or false for non-atomic operations.
* @return the number of removed records, or -1 on failure.
*/
int64_t kcdbremovebulk(KCDB* db, const KCSTR* keys, size_t knum, int32_t atomic);
/**
* Retrieve records at once.
* @param db a database object.
* @param keys the keys of the records to retrieve.
* @param knum specifies the number of the keys.
* @param recs an array to contain the result. Its size must be sufficient.
* @param atomic true to perform all operations atomically, or false for non-atomic operations.
* @return the number of retrieved records, or -1 on failure.
* @note The regions of the key and the value of each element of the result should be released
* with the kcfree function when it is no longer in use.
*/
int64_t kcdbgetbulk(KCDB* db, const KCSTR* keys, size_t knum, KCREC* recs, int32_t atomic);
/**
* Synchronize updated contents with the file and the device.
* @param db a database object.
* @param hard true for physical synchronization with the device, or false for logical
* synchronization with the file system.
* @param proc a postprocessor call back function. If it is NULL, no postprocessing is
* performed.
* @param opq an opaque pointer to be given to the call back function.
* @return true on success, or false on failure.
* @note The operation of the postprocessor is performed atomically and other threads accessing
* the same record are blocked. To avoid deadlock, any explicit database operation must not
* be performed in this function.
*/
int32_t kcdbsync(KCDB* db, int32_t hard, KCFILEPROC proc, void* opq);
/**
* Occupy database by locking and do something meanwhile.
* @param db a database object.
* @param writable true to use writer lock, or false to use reader lock.
* @param proc a processor object. If it is NULL, no processing is performed.
* @param opq an opaque pointer to be given to the call back function.
* @return true on success, or false on failure.
* @note The operation of the processor is performed atomically and other threads accessing
* the same record are blocked. To avoid deadlock, any explicit database operation must not
* be performed in this function.
*/
int32_t kcdboccupy(KCDB* db, int32_t writable, KCFILEPROC proc, void* opq);
/**
* Create a copy of the database file.
* @param db a database object.
* @param dest the path of the destination file.
* @return true on success, or false on failure.
*/
int32_t kcdbcopy(KCDB* db, const char* dest);
/**
* Begin transaction.
* @param db a database object.
* @param hard true for physical synchronization with the device, or false for logical
* synchronization with the file system.
* @return true on success, or false on failure.
*/
int32_t kcdbbegintran(KCDB* db, int32_t hard);
/**
* Try to begin transaction.
* @param db a database object.
* @param hard true for physical synchronization with the device, or false for logical
* synchronization with the file system.
* @return true on success, or false on failure.
*/
int32_t kcdbbegintrantry(KCDB* db, int32_t hard);
/**
* End transaction.
* @param db a database object.
* @param commit true to commit the transaction, or false to abort the transaction.
* @return true on success, or false on failure.
*/
int32_t kcdbendtran(KCDB* db, int32_t commit);
/**
* Remove all records.
* @param db a database object.
* @return true on success, or false on failure.
*/
int32_t kcdbclear(KCDB* db);
/**
* Dump records into a file.
* @param db a database object.
* @param dest the path of the destination file.
* @return true on success, or false on failure.
*/
int32_t kcdbdumpsnap(KCDB* db, const char* dest);
/**
* Load records from a file.
* @param db a database object.
* @param src the path of the source file.
* @return true on success, or false on failure.
*/
int32_t kcdbloadsnap(KCDB* db, const char* src);
/**
* Get the number of records.
* @param db a database object.
* @return the number of records, or -1 on failure.
*/
int64_t kcdbcount(KCDB* db);
/**
* Get the size of the database file.
* @param db a database object.
* @return the size of the database file in bytes, or -1 on failure.
*/
int64_t kcdbsize(KCDB* db);
/**
* Get the path of the database file.
* @param db a database object.
* @return the path of the database file, or an empty string on failure.
* @note The region of the return value should be released with the kcfree function when it is
* no longer in use.
*/
char* kcdbpath(KCDB* db);
/**
* Get the miscellaneous status information.
* @param db a database object.
* @return the result string of tab saparated values, or NULL on failure. Each line consists of
* the attribute name and its value separated by a tab character.
* @note The region of the return value should be released with the kcfree function when it is
* no longer in use.
*/
char* kcdbstatus(KCDB* db);
/**
* Get keys matching a prefix string.
* @param db a database object.
* @param prefix the prefix string.
* @param strary an array to contain the result. Its size must be sufficient.
* @param max the maximum number to retrieve.
* @return the number of retrieved keys or -1 on failure.
* @note The region of each element of the result should be released with the kcfree function
* when it is no longer in use.
*/
int64_t kcdbmatchprefix(KCDB* db, const char* prefix, char** strary, size_t max);
/**
* Get keys matching a regular expression string.
* @param db a database object.
* @param regex the regular expression string.
* @param strary an array to contain the result. Its size must be sufficient.
* @param max the maximum number to retrieve.
* @return the number of retrieved keys or -1 on failure.
* @note The region of each element of the result should be released with the kcfree function
* when it is no longer in use.
*/
int64_t kcdbmatchregex(KCDB* db, const char* regex, char** strary, size_t max);
/**
* Get keys similar to a string in terms of the levenshtein distance.
* @param db a database object.
* @param origin the origin string.
* @param range the maximum distance of keys to adopt.
* @param utf flag to treat keys as UTF-8 strings.
* @param strary an array to contain the result. Its size must be sufficient.
* @param max the maximum number to retrieve.
* @return the number of retrieved keys or -1 on failure.
* @note The region of each element of the result should be released with the kcfree function
* when it is no longer in use.
*/
int64_t kcdbmatchsimilar(KCDB* db, const char* origin, uint32_t range, int32_t utf,
char** strary, size_t max);
/**
* Merge records from other databases.
* @param db a database object.
* @param srcary an array of the source detabase objects.
* @param srcnum the number of the elements of the source array.
* @param mode the merge mode. KCMSET to overwrite the existing value, KCMADD to keep the
* existing value, KCMREPLACE to modify the existing record only, KCMAPPEND to append the new
* value.
* @return true on success, or false on failure.
*/
int32_t kcdbmerge(KCDB* db, KCDB** srcary, size_t srcnum, uint32_t mode);
/**
* Create a polymorphic cursor object.
* @param db a database object.
* @return the return value is the created cursor object.
* @note The object of the return value should be released with the kccurdel function when it is
* no longer in use.
*/
KCCUR* kcdbcursor(KCDB* db);
/**
* Destroy a cursor object.
* @param cur the cursor object.
*/
void kccurdel(KCCUR* cur);
/**
* Accept a visitor to the current record.
* @param cur a cursor object.
* @param fullproc a call back function to visit a record.
* @param opq an opaque pointer to be given to the call back functions.
* @param writable true for writable operation, or false for read-only operation.
* @param step true to move the cursor to the next record, or false for no move.
* @return true on success, or false on failure.
* @note The operation for each record is performed atomically and other threads accessing
* the same record are blocked. To avoid deadlock, any explicit database operation must not
* be performed in this function.
*/
int32_t kccuraccept(KCCUR* cur, KCVISITFULL fullproc, void* opq,
int32_t writable, int32_t step);
/**
* Set the value of the current record.
* @param cur a cursor object.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @param step true to move the cursor to the next record, or false for no move.
* @return true on success, or false on failure.
*/
int32_t kccursetvalue(KCCUR* cur, const char* vbuf, size_t vsiz, int32_t step);
/**
* Remove the current record.
* @param cur a cursor object.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, false is returned. The cursor is moved to the
* next record implicitly.
*/
int32_t kccurremove(KCCUR* cur);
/**
* Get the key of the current record.
* @param cur a cursor object.
* @param sp the pointer to the variable into which the size of the region of the return value
* is assigned.
* @param step true to move the cursor to the next record, or false for no move.
* @return the pointer to the key region of the current record, or NULL on failure.
* @note If the cursor is invalidated, NULL is returned. Because an additional zero
* code is appended at the end of the region of the return value, the return value can be
* treated as a C-style string. The region of the return value should be released with the
* kcfree function when it is no longer in use.
*/
char* kccurgetkey(KCCUR* cur, size_t* sp, int32_t step);
/**
* Get the value of the current record.
* @param cur a cursor object.
* @param sp the pointer to the variable into which the size of the region of the return value
* is assigned.
* @param step true to move the cursor to the next record, or false for no move.
* @return the pointer to the value region of the current record, or NULL on failure.
* @note If the cursor is invalidated, NULL is returned. Because an additional zero
* code is appended at the end of the region of the return value, the return value can be
* treated as a C-style string. The region of the return value should be released with the
* kcfree function when it is no longer in use.
*/
char* kccurgetvalue(KCCUR* cur, size_t* sp, int32_t step);
/**
* Get a pair of the key and the value of the current record.
* @param cur a cursor object.
* @param ksp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param vbp the pointer to the variable into which the pointer to the value region is
* assigned.
* @param vsp the pointer to the variable into which the size of the value region is
* assigned.
* @param step true to move the cursor to the next record, or false for no move.
* @return the pointer to the pair of the key region, or NULL on failure.
* @note If the cursor is invalidated, NULL is returned. Because an additional zero code is
* appended at the end of each region of the key and the value, each region can be treated
* as a C-style string. The region of the return value should be released with the kcfree
* function when it is no longer in use.
*/
char* kccurget(KCCUR* cur, size_t* ksp, const char** vbp, size_t* vsp, int32_t step);
/**
* Get a pair of the key and the value of the current record and remove it atomically.
* @param cur a cursor object.
* @param ksp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param vbp the pointer to the variable into which the pointer to the value region is
* assigned.
* @param vsp the pointer to the variable into which the size of the value region is
* assigned.
* @return the pointer to the pair of the key region, or NULL on failure.
* @note If the cursor is invalidated, NULL is returned. Because an additional zero code is
* appended at the end of each region of the key and the value, each region can be treated
* as a C-style string. The region of the return value should be released with the kcfree
* function when it is no longer in use. The cursor is moved to the next record implicitly.
*/
char* kccurseize(KCCUR* cur, size_t* ksp, const char** vbp, size_t* vsp);
/**
* Jump the cursor to the first record for forward scan.
* @param cur a cursor object.
* @return true on success, or false on failure.
*/
int32_t kccurjump(KCCUR* cur);
/**
* Jump the cursor to a record for forward scan.
* @param cur a cursor object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return true on success, or false on failure.
*/
int32_t kccurjumpkey(KCCUR* cur, const char* kbuf, size_t ksiz);
/**
* Jump the cursor to the last record for backward scan.
* @param cur a cursor object.
* @return true on success, or false on failure.
* @note This method is dedicated to tree databases. Some database types, especially hash
* databases, may provide a dummy implementation.
*/
int32_t kccurjumpback(KCCUR* cur);
/**
* Jump the cursor to a record for backward scan.
* @param cur a cursor object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return true on success, or false on failure.
* @note This method is dedicated to tree databases. Some database types, especially hash
* databases, will provide a dummy implementation.
*/
int32_t kccurjumpbackkey(KCCUR* cur, const char* kbuf, size_t ksiz);
/**
* Step the cursor to the next record.
* @param cur a cursor object.
* @return true on success, or false on failure.
*/
int32_t kccurstep(KCCUR* cur);
/**
* Step the cursor to the previous record.
* @param cur a cursor object.
* @return true on success, or false on failure.
* @note This method is dedicated to tree databases. Some database types, especially hash
* databases, may provide a dummy implementation.
*/
int32_t kccurstepback(KCCUR* cur);
/**
* Get the database object.
* @param cur a cursor object.
* @return the database object.
*/
KCDB* kccurdb(KCCUR* cur);
/**
* Get the code of the last happened error.
* @param cur a cursor object.
* @return the code of the last happened error.
*/
int32_t kccurecode(KCCUR* cur);
/**
* Get the supplement message of the last happened error.
* @param cur a cursor object.
* @return the supplement message of the last happened error.
*/
const char* kccuremsg(KCCUR* cur);
/**
* C wrapper of index database.
*/
typedef struct {
void* db; /**< dummy member */
} KCIDX;
/**
* Create an index database object.
* @return the created database object.
* @note The object of the return value should be released with the kcidxdel function when it is
* no longer in use.
*/
KCIDX* kcidxnew(void);
/**
* Destroy a database object.
* @param idx the database object.
*/
void kcidxdel(KCIDX* idx);
/**
* Open a database file.
* @param idx a database object.
* @param path the path of a database file. The same as with the polymorphic database.
* @param mode the connection mode. The same as with the polymorphic database.
* @return true on success, or false on failure.
*/
int32_t kcidxopen(KCIDX* idx, const char* path, uint32_t mode);
/**
* Close the database file.
* @param idx a database object.
* @return true on success, or false on failure.
*/
int32_t kcidxclose(KCIDX* idx);
/**
* Get the code of the last happened error.
* @param idx a database object.
* @return the code of the last happened error.
*/
int32_t kcidxecode(KCIDX* idx);
/**
* Get the supplement message of the last happened error.
* @param idx a database object.
* @return the supplement message of the last happened error.
*/
const char* kcidxemsg(KCIDX* idx);
/**
* Set the value of a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the value is overwritten.
*/
int32_t kcidxset(KCIDX* idx, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Add a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the record is not modified and false is returned.
*/
int32_t kcidxadd(KCIDX* idx, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Replace the value of a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, no new record is created and false is returned.
* If the corresponding record exists, the value is modified.
*/
int32_t kcidxreplace(KCIDX* idx, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Append the value of a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the given value is appended at the end of the existing value.
*/
int32_t kcidxappend(KCIDX* idx, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Remove a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, false is returned.
*/
int32_t kcidxremove(KCIDX* idx, const char* kbuf, size_t ksiz);
/**
* Retrieve the value of a record.
* @param idx a database object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the corresponding record, or NULL on failure.
* @note If no record corresponds to the key, NULL is returned. Because an additional zero
* code is appended at the end of the region of the return value, the return value can be
* treated as a C-style string. The region of the return value should be released with the
* kcfree function when it is no longer in use.
*/
char* kcidxget(KCIDX* idx, const char* kbuf, size_t ksiz, size_t* sp);
/**
* Synchronize updated contents with the file and the device.
* @param idx a database object.
* @param hard true for physical synchronization with the device, or false for logical
* synchronization with the file system.
* @param proc a postprocessor call back function. If it is NULL, no postprocessing is
* performed.
* @param opq an opaque pointer to be given to the call back function.
* @return true on success, or false on failure.
* @note The operation of the postprocessor is performed atomically and other threads accessing
* the same record are blocked. To avoid deadlock, any explicit database operation must not
* be performed in this function.
*/
int32_t kcidxsync(KCIDX* idx, int32_t hard, KCFILEPROC proc, void* opq);
/**
* Remove all records.
* @param idx a database object.
* @return true on success, or false on failure.
*/
int32_t kcidxclear(KCIDX* idx);
/**
* Get the number of records.
* @param idx a database object.
* @return the number of records, or -1 on failure.
*/
int64_t kcidxcount(KCIDX* idx);
/**
* Get the size of the database file.
* @param idx a database object.
* @return the size of the database file in bytes, or -1 on failure.
*/
int64_t kcidxsize(KCIDX* idx);
/**
* Get the path of the database file.
* @param idx a database object.
* @return the path of the database file, or an empty string on failure.
* @note The region of the return value should be released with the kcfree function when it is
* no longer in use.
*/
char* kcidxpath(KCIDX* idx);
/**
* Get the miscellaneous status information.
* @param idx a database object.
* @return the result string of tab saparated values, or NULL on failure. Each line consists of
* the attribute name and its value separated by a tab character.
* @note The region of the return value should be released with the kcfree function when it is
* no longer in use.
*/
char* kcidxstatus(KCIDX* idx);
/**
* Reveal the inner database object.
* @return the inner database object, or NULL on failure.
*/
KCDB* kcidxrevealinnerdb(KCIDX* idx);
/**
* C wrapper of memory-saving string hash map.
*/
typedef struct {
void* map; /**< dummy member */
} KCMAP;
/**
* C wrapper of iterator of memory-saving string hash map.
*/
typedef struct {
void* iter; /**< dummy member */
} KCMAPITER;
/**
* C wrapper of sorter of memory-saving string hash map.
*/
typedef struct {
void* iter; /**< dummy member */
} KCMAPSORT;
/**
* Create a string hash map object.
* @param bnum the number of buckets of the hash table. If it is not more than 0, the default
* setting 31 is specified.
* @return the created map object.
* @note The object of the return value should be released with the kcmapdel function when it is
* no longer in use.
*/
KCMAP* kcmapnew(size_t bnum);
/**
* Destroy a map object.
* @param map the map object.
*/
void kcmapdel(KCMAP* map);
/**
* Set the value of a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the value is overwritten.
*/
void kcmapset(KCMAP* map, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Add a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the record is not modified and false is returned.
*/
int32_t kcmapadd(KCMAP* map, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Replace the value of a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, no new record is created and false is returned.
* If the corresponding record exists, the value is modified.
*/
int32_t kcmapreplace(KCMAP* map, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Append the value of a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param vbuf the pointer to the value region.
* @param vsiz the size of the value region.
* @note If no record corresponds to the key, a new record is created. If the corresponding
* record exists, the given value is appended at the end of the existing value.
*/
void kcmapappend(KCMAP* map, const char* kbuf, size_t ksiz, const char* vbuf, size_t vsiz);
/**
* Remove a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @return true on success, or false on failure.
* @note If no record corresponds to the key, false is returned.
*/
int32_t kcmapremove(KCMAP* map, const char* kbuf, size_t ksiz);
/**
* Retrieve the value of a record.
* @param map the map object.
* @param kbuf the pointer to the key region.
* @param ksiz the size of the key region.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the corresponding record, or NULL on failure.
*/
const char* kcmapget(KCMAP* map, const char* kbuf, size_t ksiz, size_t* sp);
/**
* Remove all records.
* @param map the map object.
*/
void kcmapclear(KCMAP* map);
/**
* Get the number of records.
* @param map the map object.
* @return the number of records.
*/
size_t kcmapcount(KCMAP* map);
/**
* Create a string hash map iterator object.
* @param map a map object.
* @return the return value is the created iterator object.
* @note The object of the return value should be released with the kcmapiterdel function when
* it is no longer in use.
* @note This object will not be invalidated even when the map object is updated once.
* However, phantom records may be retrieved if they are removed after creation of each iterator.
*/
KCMAPITER* kcmapiterator(KCMAP* map);
/**
* Destroy an iterator object.
* @param iter the iterator object.
*/
void kcmapiterdel(KCMAPITER* iter);
/**
* Get the key of the current record.
* @param iter the iterator object.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the key region of the current record, or NULL on failure.
*/
const char* kcmapitergetkey(KCMAPITER* iter, size_t* sp);
/**
* Get the value of the current record.
* @param iter the iterator object.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the current record, or NULL on failure.
*/
const char* kcmapitergetvalue(KCMAPITER* iter, size_t* sp);
/**
* Get a pair of the key and the value of the current record.
* @param iter the iterator object.
* @param ksp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param vbp the pointer to the variable into which the pointer to the value region is
* assigned.
* @param vsp the pointer to the variable into which the size of the value region is
* assigned.
* @return the pointer to the key region, or NULL on failure.
*/
const char* kcmapiterget(KCMAPITER* iter, size_t* ksp, const char** vbp, size_t* vsp);
/**
* Step the cursor to the next record.
* @param iter the iterator object.
*/
void kcmapiterstep(KCMAPITER* iter);
/**
* Create a string hash map sorter object.
* @param map a map object.
* @return the return value is the created sorter object.
* @note The object of the return value should be released with the kcmapsortdel function when
* it is no longer in use.
* @note This object will not be invalidated even when the map object is updated once.
* However, phantom records may be retrieved if they are removed after creation of each sorter.
*/
KCMAPSORT* kcmapsorter(KCMAP* map);
/**
* Destroy an sorter object.
* @param sort the sorter object.
*/
void kcmapsortdel(KCMAPSORT* sort);
/**
* Get the key of the current record.
* @param sort the sorter object.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the key region of the current record, or NULL on failure.
*/
const char* kcmapsortgetkey(KCMAPSORT* sort, size_t* sp);
/**
* Get the value of the current record.
* @param sort the sorter object.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the value region of the current record, or NULL on failure.
*/
const char* kcmapsortgetvalue(KCMAPSORT* sort, size_t* sp);
/**
* Get a pair of the key and the value of the current record.
* @param sort the sorter object.
* @param ksp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @param vbp the pointer to the variable into which the pointer to the value region is
* assigned.
* @param vsp the pointer to the variable into which the size of the value region is
* assigned.
* @return the pointer to the key region, or NULL on failure.
*/
const char* kcmapsortget(KCMAPSORT* sort, size_t* ksp, const char** vbp, size_t* vsp);
/**
* Step the cursor to the next record.
* @param sort the sorter object.
*/
void kcmapsortstep(KCMAPSORT* sort);
/**
* C wrapper of memory-saving string hash map.
*/
typedef struct {
void* list; /**< dummy member */
} KCLIST;
/**
* Create a string array list object.
* @return the created list object.
* @note The object of the return value should be released with the kclistdel function when it is
* no longer in use.
*/
KCLIST* kclistnew();
/**
* Destroy a list object.
* @param list the list object.
*/
void kclistdel(KCLIST* list);
/**
* Insert a record at the bottom of the list.
* @param list the list object.
* @param buf the pointer to the record region.
* @param size the size of the record region.
*/
void kclistpush(KCLIST* list, const char* buf, size_t size);
/**
* Remove a record at the bottom of the list.
* @param list the list object.
* @return true if the operation success, or false if there is no record in the list.
*/
int32_t kclistpop(KCLIST* list);
/**
* Insert a record at the top of the list.
* @param list the list object.
* @param buf the pointer to the record region.
* @param size the size of the record region.
*/
void kclistunshift(KCLIST* list, const char* buf, size_t size);
/**
* Remove a record at the top of the list.
* @param list the list object.
* @return true if the operation success, or false if there is no record in the list.
*/
int32_t kclistshift(KCLIST* list);
/**
* Insert a record at the position of the given index of the list.
* @param list the list object.
* @param buf the pointer to the record region.
* @param size the size of the record region.
* @param idx the index of the position. It must be equal to or less than the number of
* records.
*/
void kclistinsert(KCLIST* list, const char* buf, size_t size, size_t idx);
/**
* Remove a record at the position of the given index of the list.
* @param list the list object.
* @param idx the index of the position. It must be less than the number of records.
*/
void kclistremove(KCLIST* list, size_t idx);
/**
* Retrieve a record at the position of the given index of the list.
* @param list the list object.
* @param idx the index of the position. It must be less than the number of records.
* @param sp the pointer to the variable into which the size of the region of the return
* value is assigned.
* @return the pointer to the region of the retrieved record.
*/
const char* kclistget(KCLIST* list, size_t idx, size_t* sp);
/**
* Remove all records.
* @param list the list object.
*/
void kclistclear(KCLIST* list);
/**
* Get the number of records.
* @param list the list object.
* @return the number of records.
*/
size_t kclistcount(KCLIST* list);
#if defined(__cplusplus)
}
#endif
#endif /* duplication check */
/* END OF FILE */
|