/usr/include/elektra/key.hpp is in libelektra-dev 0.8.7-4.
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 | #ifndef ELEKTRA_KEY_HPP
#define ELEKTRA_KEY_HPP
#include <string>
#include <cstring>
#include <cstdarg>
#include <sstream>
#include <keyexcept.hpp>
#include <kdb.h>
namespace kdb
{
/**
* @copydoc key
*
* This class is an wrapper for an optional, refcounted ckdb::Key.
* It is like an shared_ptr<ckdb::Key>, but the
* shared_ptr functionality is already within the Key and exposed
* with this wrapper.
*
* @par optional
* A key can be constructed with an null pointer, by using
* Key (static_cast<ckdb::Key*>(0));
* or made empty afterwards by using release() or assign a null key.
* To check if there is an associated managed object the user
* can use operator bool().
*
* @par references
* Copies of keys are cheap because they are only flat.
* If you really need a deep copy, you can use copy() or dup().
* If you release() an object, the reference counter will
* stay
* All other operations operate on references.
*
* @par documentation
* Note that the documentation is typically copied from the underlying
* function which is wrapped and sometimes extended with C++ specific
* details. So you might find C examples within the C++ documentation.
*
*
* @invariant Key either has a working underlying Elektra Key
* object or a null pointer.
* The Key, however, might be invalid (see isValid()) or null
* (see operator bool()).
*
* @note that the reference counting in the keys is mutable,
* so that const keys can be passed around by value.
*/
class Key
{
public:
// constructors
inline Key ();
inline Key (ckdb::Key * k);
inline Key (Key &k);
inline Key (Key const & k);
inline explicit Key (const char * keyName, ...);
inline explicit Key (const std::string keyName, ...);
inline explicit Key (const char * keyName, va_list ap);
// reference handling
inline void operator ++(int) const;
inline void operator ++() const;
inline void operator --(int) const;
inline void operator --() const;
inline ssize_t getReferenceCounter() const;
// basic methods
inline Key& operator= (ckdb::Key *k);
inline Key& operator= (const Key &k);
inline void copy (const Key &other);
inline void clear ();
inline ckdb::Key* operator->() const;
inline Key* operator->();
inline ckdb::Key* getKey () const;
inline ckdb::Key* operator* () const;
inline ckdb::Key* release ();
inline ckdb::Key* dup () const;
inline ~Key ();
// name manipulation
inline std::string getName() const;
inline ssize_t getNameSize() const;
inline std::string getBaseName() const;
inline ssize_t getBaseNameSize() const;
inline std::string getDirName() const;
inline void setName (const std::string &newName);
inline void setBaseName (const std::string &baseName);
inline void addBaseName (const std::string &baseName);
inline ssize_t getFullNameSize() const;
inline std::string getFullName() const;
inline Key& operator= (const std::string &newName);
inline Key& operator+= (const std::string &baseName);
inline Key& operator-= (const std::string &baseName);
inline Key& operator= (const char *newName);
inline Key& operator+= (const char *baseName);
inline Key& operator-= (const char *baseName);
// operators
inline bool operator ==(const Key &k) const;
inline bool operator !=(const Key &k) const;
inline bool operator < (const Key& other) const;
inline bool operator <= (const Key& other) const;
inline bool operator > (const Key& other) const;
inline bool operator >= (const Key& other) const;
inline operator bool() const;
// value operations
template <class T>
inline T get() const;
template <class T>
inline void set(T x);
inline std::string getString() const;
inline void setString(std::string newString);
inline ssize_t getStringSize() const;
typedef void (*func_t)();
inline func_t getFunc() const;
inline const void *getValue() const;
inline std::string getBinary() const;
inline ssize_t getBinarySize() const;
inline ssize_t setBinary(const void *newBinary, size_t dataSize);
// meta data
inline bool hasMeta(const std::string &metaName) const;
template <class T>
inline T getMeta(const std::string &metaName) const;
template <class T>
inline void setMeta(const std::string &metaName, T x);
inline void delMeta(const std::string &metaName);
inline void copyMeta(const Key &other, const std::string &metaName);
inline void copyAllMeta(const Key &other);
inline void rewindMeta () const;
inline const Key nextMeta ();
inline const Key currentMeta () const;
// Methods for Making tests
inline bool isValid() const;
inline bool isSystem() const;
inline bool isUser() const;
inline bool isString() const;
inline bool isBinary() const;
inline bool isInactive() const;
inline bool isBelow(const Key &k) const;
inline bool isBelowOrSame(const Key &k) const;
inline bool isDirectBelow(const Key &k) const;
private:
inline int del ();
ckdb::Key * key; ///< holds an elektra key
};
/**
* Constructs an empty, invalid key.
*
* @note That this is not a null key, so the key will
* evaluate to true.
*
* @see isValid(), operator bool()
*/
inline Key::Key () :
key(ckdb::keyNew (0))
{
operator++();
}
/**
* Constructs a key out of a C key.
*
* @note If you pass a null pointer here, the key will
* evaluate to false.
*
* @param k the key to work with
*
* @see isValid(), operator bool()
*/
inline Key::Key (ckdb::Key * k) :
key(k)
{
operator++();
}
/**
* Takes a reference of another key.
*
* The key will not be copied, but the reference
* counter will be increased.
*
* @param k the key to work with
*/
inline Key::Key (Key &k) :
key(k.key)
{
operator++();
}
/**
* Takes a reference of another key.
*
* The key will not be copied, but the reference
* counter will be increased.
*
* @param k the key to work with
*/
inline Key::Key (Key const & k) :
key(k.key)
{
operator++();
}
/**
* @copydoc keyNew
*
* @throw KeyInvalidName if key could not be constructed (typically name
* wrong or at runtime on allocation problems)
*
* @param keyName the name of the new key
*/
inline Key::Key (const char * keyName, ...)
{
va_list ap;
va_start(ap, keyName);
key = ckdb::keyVNew (keyName, ap);
va_end(ap);
if (!key) throw KeyInvalidName();
operator++();
}
/**
* @copydoc keyNew
*
* @throw KeyInvalidName if key could not be constructed (typically name
* wrong or at runtime on allocation problems)
*
* @warning Not supported on some compilers, e.g.
* clang which require you to only pass non-POD
* in varg lists.
*
* @param keyName the name of the new key
*/
inline Key::Key (const std::string keyName, ...)
{
va_list ap;
va_start(ap, keyName);
key = ckdb::keyVNew (keyName.c_str(), ap);
va_end(ap);
if (!key) throw KeyInvalidName();
operator++();
}
/**
* @copydoc keyNew
*
* @throw KeyInvalidName if key could not be constructed (typically name
* wrong or at runtime on allocation problems)
*
* @param keyName the name of the new key
* @param ap the variable argument list pointer
*/
inline Key::Key (const char * keyName, va_list ap)
{
key = ckdb::keyVNew (keyName, ap);
if (!key) throw KeyInvalidName();
operator++();
}
/**
* @copydoc keyIncRef
*/
void Key::operator ++(int) const
{
operator++();
}
/**
* @copydoc keyIncRef
*/
void Key::operator ++() const
{
ckdb::keyIncRef(key);
}
/**
* @copydoc keyDecRef
*/
void Key::operator --(int) const
{
operator--();
}
/**
* @copydoc keyDecRef
*/
void Key::operator --() const
{
ckdb::keyDecRef(key);
}
/**
* @copydoc keyGetRef
*/
inline ssize_t Key::getReferenceCounter() const
{
return ckdb::keyGetRef(key);
}
/**
* Assign a C key.
*
* Will call del() on the old key.
*/
inline Key& Key::operator= (ckdb::Key *k)
{
if (key != k)
{
del();
key = k;
operator++();
}
return *this;
}
/**
* Assign a key.
*
* Will call del() on the old key.
*/
inline Key& Key::operator= (const Key &k)
{
if (this != &k)
{
del();
key = k.key;
operator++();
}
return *this;
}
/**
* @copydoc keyCopy
*/
inline void Key::copy (const Key &other)
{
ckdb::keyCopy(key,other.key);
}
/**
* Clears/Invalidates a key.
*
* Afterwards the object is empty again.
*
* @note This is not a null key, so it will
* evaluate to true.
* isValid() will, however, be false.
*
* @see release()
* @see isValid(), operator bool()
*
* @copydoc keyClear
*/
inline void Key::clear ()
{
ckdb::keyClear(key);
}
/**
* Passes out the raw key pointer.
*
* This pointer can be used to directly change the underlying key
* object.
*
* \note that the ownership remains in the object
*/
ckdb::Key * Key::getKey () const
{
return key;
}
/**
* Is a abbreviation for getKey.
*
* @copydoc getKey
*
* @see getKey()
*/
ckdb::Key * Key::operator* () const
{
return key;
}
/**
* @returns a pointer to this object
*
* Needed for KeySet iterators.
* @see KeySetIterator
*/
Key* Key::operator-> ()
{
return this;
}
/**
* Passes out the raw key pointer.
*
* \note that the ownership is moved outside.
*
* The key will stay empty.
*/
ckdb::Key* Key::release ()
{
ckdb::Key* ret = key;
operator --();
key = 0;
return ret;
}
/**
* @copydoc keyDup
*/
ckdb::Key* Key::dup () const
{
return ckdb::keyDup(getKey());
}
/**
* Destructs the key.
*
* @copydoc del()
*
* @see del()
*/
inline Key::~Key ()
{
del();
}
/**
* @copydoc keyName
*
* @note unlike in the C version, it is safe to change the returned
* string.
*/
inline std::string Key::getName() const
{
return std::string (ckdb::keyName(key));
}
/**
* @copydoc keyGetNameSize
*/
inline ssize_t Key::getNameSize() const
{
return ckdb::keyGetNameSize (getKey());
}
/**
* @copydoc keyGetBaseNameSize
*/
inline ssize_t Key::getBaseNameSize() const
{
return ckdb::keyGetBaseNameSize(getKey());
}
/**
* @copydoc keyBaseName
*/
inline std::string Key::getBaseName() const
{
return std::string (ckdb::keyBaseName(key));
}
/**
* @return the dir name of the key
*
* e.g. system/sw/dir/key
* will return system/sw/dir
*/
inline std::string Key::getDirName() const
{
std::string ret = ckdb::keyName(key);
return ret.substr(0, ret.rfind('/'));
}
/**
* @copydoc keySetName
*
* @throw KeyInvalidName if the name is not valid
* */
inline void Key::setName (const std::string &newName)
{
if (ckdb::keySetName (getKey(), newName.c_str()) == -1)
{
throw KeyInvalidName();
}
}
/**Sets a base name for a key.
*
* @copydoc keySetBaseName
*
* @throw KeyInvalidName if the name is not valid
*/
inline void Key::setBaseName (const std::string & baseName)
{
if (ckdb::keySetBaseName (getKey(), baseName.c_str()) == -1)
{
throw KeyInvalidName();
}
}
/** Adds a base name for a key
*
* @copydoc keyAddBaseName
*
* @throw KeyInvalidName if the name is not valid
*/
inline void Key::addBaseName (const std::string &baseName)
{
if (ckdb::keyAddBaseName (getKey(), baseName.c_str()) == -1)
{
throw KeyInvalidName();
}
}
/**
* @copydoc keyGetFullNameSize
*/
inline ssize_t Key::getFullNameSize() const
{
return ckdb::keyGetFullNameSize (getKey());
}
/**
* @copydoc keyGetFullName
*
* @throw KeyException if key is null
*/
inline std::string Key::getFullName() const
{
ssize_t csize = getFullNameSize();
if (csize == -1)
{
throw KeyException();
}
if (csize == 0)
{
return "";
}
std::string str (csize-1, '\0');
ckdb::keyGetFullName (getKey(), &str[0], csize);
return str;
}
/**
* Assign the name of a key.
*
* @see keySetName
*/
inline Key& Key::operator= (const std::string &newName)
{
ckdb::keySetName(getKey(), newName.c_str());
return *this;
}
/**
* Add a new basename.
*
* @see keyAddBaseName()
*/
inline Key& Key::operator+= (const std::string &newAddBaseName)
{
ckdb::keyAddBaseName(getKey(), newAddBaseName.c_str());
return *this;
}
/**
* Set a new basename.
*
* @see keySetBaseName()
*/
inline Key& Key::operator-= (const std::string &newSetBaseName)
{
ckdb::keySetBaseName(getKey(), newSetBaseName.c_str());
return *this;
}
/**
* @copydoc Key::operator= (const std::string &newName)
*/
inline Key& Key::operator= (const char *newName)
{
ckdb::keySetName(getKey(), newName);
return *this;
}
/**
* @copydoc Key::operator+= (const std::string &)
*/
inline Key& Key::operator+= (const char *newAddBaseName)
{
ckdb::keyAddBaseName(getKey(), newAddBaseName);
return *this;
}
/**
* @copydoc Key::operator-= (const std::string &)
*/
inline Key& Key::operator-= (const char *newSetBaseName)
{
ckdb::keySetBaseName(getKey(), newSetBaseName);
return *this;
}
/**
* @copydoc keyCmp
*
* @retval true == 0
*/
inline bool Key::operator ==(const Key &k) const
{
return ckdb::keyCmp(key, k.key) == 0;
}
/**
* @copydoc keyCmp
*
* @retval true != 0
*/
inline bool Key::operator !=(const Key &k) const
{
return ckdb::keyCmp(key, k.key) != 0;
}
/**
* @copydoc keyCmp
*
* @retval true < 0
*/
inline bool Key::operator < (const Key& other) const
{
return ckdb::keyCmp(key, other.key) < 0;
}
/**
* @copydoc keyCmp
*
* @retval true <= 0
*/
inline bool Key::operator <= (const Key& other) const
{
return ckdb::keyCmp(key, other.key) <= 0;
}
/**
* @copydoc keyCmp
*
* @retval true > 0
*/
inline bool Key::operator > (const Key& other) const
{
return ckdb::keyCmp(key, other.key) > 0;
}
/**
* @copydoc keyCmp
*
* @retval true >= 0
*/
inline bool Key::operator >= (const Key& other) const
{
return ckdb::keyCmp(key, other.key) >= 0;
}
/**
* This is for loops and lookups only.
*
* For loops it checks if there are still more keys.
* For lookups it checks if a key could be found.
*
* @warning you should not construct or use null keys
*
* @return false on null keys
* @return true otherwise
*/
inline Key::operator bool() const
{
return key != 0;
}
/**
* Get a key value.
*
* You can write your own template specialication, e.g.:
* @code
* @endcode
*
* @copydoc getString
*
* This method tries to serialise the string to the given type.
*/
template <class T>
inline T Key::get() const
{
std::string str;
str = getString();
std::istringstream ist(str);
T x;
ist >> x; // convert string to type
if (ist.fail())
{
throw KeyTypeConversion();
}
return x;
}
template <>
inline std::string Key::get() const
{
return getString();
}
/**
* Set a key value.
*
* @copydoc setString
*
* This method tries to deserialise the string to the given type.
*/
template <class T>
inline void Key::set(T x)
{
std::string str;
std::ostringstream ost;
ost << x; // convert type to string
if (ost.fail())
{
throw KeyTypeConversion();
}
setString (ost.str());
}
/**
* @return the string directly from the key.
*
* It should be the same as get().
* @return empty string on null pointers
*
* @throw KeyException on null key or not a valid size
* @throw KeyTypeMismatch if key holds binary data and not a string
*
* @note unlike in the C version, it is safe to change the returned
* string.
*
* @see isString(), getBinary()
*/
inline std::string Key::getString() const
{
ssize_t csize = getStringSize();
if (csize == -1)
{
throw KeyException();
}
if (csize == 0)
{
return "";
}
std::string str (csize-1, '\0');
if (ckdb::keyGetString (getKey(), &str[0], csize) == -1)
{
throw KeyTypeMismatch();
}
return str;
}
/**
* @copydoc keyGetValueSize()
*/
inline ssize_t Key::getStringSize() const
{
return ckdb::keyGetValueSize(key);
}
/**
* Elektra can store function pointers as binary.
* This function returns such a function pointer.
*
* @throw KeyTypeMismatch if no binary data found, or binary data has not correct length
*
* @return a function pointer stored with setBinary()
*/
inline Key::func_t Key::getFunc() const
{
union {Key::func_t f; void* v;} conversation;
if (ckdb::keyGetBinary(getKey(),
&conversation.v,
sizeof(conversation)) != sizeof(conversation))
throw KeyTypeMismatch();
return conversation.f;
}
/**
* @copydoc keySetString
*/
inline void Key::setString(std::string newString)
{
ckdb::keySetString (getKey(), newString.c_str());
}
/**
* @copydoc keyValue
*
* @return the value of the key
* @see getBinary()
*/
inline const void * Key::getValue() const
{
return ckdb::keyValue(getKey());
}
/**
* @returns the binary Value of the key.
*
* @retval "" on null pointers (size == 0) and on data only containing \\0
*
* @note if you need to distinguish between null pointers and data
* containing \\0 you can use getValue().
*
* @throw KeyException on invalid binary size
* @throw KeyTypeMismatch if key is string and not a binary
*
* @copydoc keyGetBinary
*
* @see isBinary(), getString(), getValue()
**/
inline std::string Key::getBinary() const
{
ssize_t csize = getBinarySize();
if (csize == -1)
{
throw KeyException();
}
if (csize == 0)
{
return "";
}
std::string str (csize, '\0');
if (ckdb::keyGetBinary (getKey(), &str[0], csize) == -1)
{
throw KeyTypeMismatch();
}
return str;
}
/**
* @copydoc keyGetValueSize()
*/
inline ssize_t Key::getBinarySize() const
{
return ckdb::keyGetValueSize(key);
}
/**
* @copydoc keySetBinary
*/
inline ssize_t Key::setBinary(const void *newBinary, size_t dataSize)
{
return ckdb::keySetBinary (getKey(), newBinary, dataSize);
}
/**
* @copydoc keyGetMeta
*
* You can specify your own template specialisation:
* @code
template<>
inline yourtype Key::getMeta(const std::string &name) const
{
yourtype x;
std::string str;
str = std::string(
static_cast<const char*>(
ckdb::keyValue(
ckdb::keyGetMeta(key, name.c_str())
)
)
);
return yourconversion(str);
}
* @endcode
*
* @throw KeyTypeConversion if meta data could not be parsed
*
* @note No exception will be thrown if a const Key or char* is requested,
* but don't forget the const: getMeta<const Key>,
* otherwise you will get an compiler error.
*
* If no meta is available:
* - char* is null (evaluates to 0)
* - const Key is null (evaluate to false)
* - otherwise the default constructed type will be returned
* @see hasMeta
*
* @see delMeta(), setMeta(), copyMeta(), copyAllMeta()
*/
template <class T>
inline T Key::getMeta(const std::string &metaName) const
{
Key k(const_cast<ckdb::Key*>(ckdb::keyGetMeta(key, metaName.c_str())));
if (!k)
{
return T();
}
return k.get<T>();
}
/**
* @retval true if there is a metadata with given name
* @retval false if no such metadata exists
*
*@see getMeta()
*/
inline bool Key::hasMeta(const std::string &metaName) const
{
Key k(const_cast<ckdb::Key*>(ckdb::keyGetMeta(key, metaName.c_str())));
return k;
}
template<>
inline const ckdb::Key* Key::getMeta(const std::string &name) const
{
return
ckdb::keyGetMeta(key, name.c_str());
}
template<>
inline const Key Key::getMeta(const std::string &name) const
{
const ckdb::Key *k = ckdb::keyGetMeta(key, name.c_str());
return Key(const_cast<ckdb::Key*>(k));
}
template<>
inline const char* Key::getMeta(const std::string &name) const
{
return
static_cast<const char*>(
ckdb::keyValue(
ckdb::keyGetMeta(key, name.c_str())
)
);
}
template<>
inline std::string Key::getMeta(const std::string &name) const
{
const char *v =
static_cast<const char*>(
ckdb::keyValue(
ckdb::keyGetMeta(key, name.c_str())
)
);
if (!v)
{
return std::string();
}
std::string str;
str = std::string(v);
return str;
}
/**
* Set metadata for key.
*
* @copydoc keySetMeta
*
* @warning unlike the C Interface, it is not possible to remove
* metadata with this method.
* k.setMeta("something", NULL) will lead to set the number 0 or to
* something different (may depend on compiler definition of NULL).
* See discussion in Issue
* https://github.com/ElektraInitiative/libelektra/issues/8
*
* Use delMeta() to avoid these issues.
*
* @see delMeta(), getMeta(), copyMeta(), copyAllMeta()
*/
template <class T>
inline void Key::setMeta(const std::string &metaName, T x)
{
Key k;
k.set<T>(x);
ckdb::keySetMeta(key, metaName.c_str(), k.getString().c_str());
}
/**
* Delete metadata for key.
*
* @see setMeta(), getMeta(), copyMeta(), copyAllMeta()
*/
inline void Key::delMeta(const std::string &metaName)
{
ckdb::keySetMeta(key, metaName.c_str(), 0);
}
/**
* @copydoc keyCopyMeta
*
* @see getMeta(), setMeta(), copyAllMeta()
*/
inline void Key::copyMeta(const Key &other, const std::string &metaName)
{
ckdb::keyCopyMeta(key, other.key, metaName.c_str());
}
/**
* @copydoc keyCopyAllMeta
*
* @see getMeta(), setMeta(), copyMeta()
*/
inline void Key::copyAllMeta(const Key &other)
{
ckdb::keyCopyAllMeta(key, other.key);
}
/**
* @copydoc keyRewindMeta
*
* @see nextMeta(), currentMeta()
*/
inline void Key::rewindMeta() const
{
ckdb::keyRewindMeta(key);
}
/**
* @copydoc keyNextMeta
*
* @see rewindMeta(), currentMeta()
*/
inline const Key Key::nextMeta()
{
const ckdb::Key *k = ckdb::keyNextMeta(key);
return Key(const_cast<ckdb::Key*>(k));
}
/**
* @copydoc keyCurrentMeta
*
* @note that the key will be null if last meta data is found.
*
* @code
* k.rewindMeta();
* while (meta = k.nextMeta())
* {
* cout << meta.getName() << " " << meta.getString() << endl;
* }
* @endcode
*
* @see rewindMeta(), nextMeta()
*/
inline const Key Key::currentMeta() const
{
return Key(
const_cast<ckdb::Key*>(
ckdb::keyCurrentMeta(const_cast<const ckdb::Key*>(
key)
)
)
);
}
/** @return if the key is valid
*
* An invalid key has no name.
* The name of valid keys either start with user or system.
*
* @retval true if the key has a valid name
* @retval false if the key has an invalid name
*
* @see getName(), isUser(), isSystem()
*/
inline bool Key::isValid() const
{
return ckdb::keyGetNameSize(getKey()) > 1;
}
/**
* Name starts with "system".
*
* @retval true if it is a system key
* @retval false otherwise
*/
inline bool Key::isSystem() const
{
return !strncmp(ckdb::keyName(key), "system", 6);
}
/**
* Name starts with "user".
*
* @retval true if it is a user key
* @retval false otherwise
*/
inline bool Key::isUser() const
{
return !strncmp(ckdb::keyName(key), "user", 4);
}
/**
* @copydoc keyIsString
*/
inline bool Key::isString() const
{
return ckdb::keyIsString(key);
}
/**
* @copydoc keyIsBinary
*/
inline bool Key::isBinary() const
{
return ckdb::keyIsBinary(key);
}
/**
* @copydoc keyIsInactive
*/
inline bool Key::isInactive () const
{
return ckdb::keyIsInactive (key);
}
/**
* @param k the other key
* @return true if our key is below k
*
* @copydoc keyIsBelow
*/
inline bool Key::isBelow(const Key & k) const
{
int ret = ckdb::keyIsBelow(k.getKey(), key);
if (ret == -1) return false;
return ret;
}
/**
* @param k the other key
* @return true if our key is below k or the same as k
*
* @copydoc keyIsBelowOrSame
*/
inline bool Key::isBelowOrSame(const Key & k) const
{
int ret = ckdb::keyIsBelowOrSame(k.getKey(), key);
if (ret == -1) return false;
return ret;
}
/**
* @param k the other key
* @return true if our key is direct below k
*
* @copydoc keyIsDirectBelow
*/
inline bool Key::isDirectBelow(const Key & k) const
{
int ret = ckdb::keyIsDirectBelow(k.getKey(), key);
if (ret == -1) return false;
return ret;
}
/**
* Deallocate the key if the reference counter reached zero.
*
* If there are still references, the function will only
* decrement the reference counter.
*
* @copydoc keyDel
*/
inline int Key::del ()
{
operator --();
return ckdb::keyDel(key);
}
} // end of namespace kdb
#endif
|