/usr/include/ptlib/dict.h is in libpt-1.10.10-dev 1.10.10-3.1ubuntu1.
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 | /*
* dict.h
*
* Dictionary (hash table) Container classes.
*
* Portable Windows Library
*
* Copyright (c) 1993-1998 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions are Copyright (C) 1993 Free Software Foundation, Inc.
* All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* $Log: dict.h,v $
* Revision 1.35 2005/11/25 03:43:47 csoutheren
* Fixed function argument comments to be compatible with Doxygen
*
* Revision 1.34 2004/11/23 11:33:08 csoutheren
* Fixed problem with RemoveAt returning invalid pointer in some cases,
* and added extra documentation on this case.
* Thanks to Diego Tartara for pointing out this potential problem
*
* Revision 1.33 2004/04/09 03:42:34 csoutheren
* Removed all usages of "virtual inline" and "inline virtual"
*
* Revision 1.32 2004/04/03 23:53:09 csoutheren
* Added various changes to improce compatibility with the Sun Forte compiler
* Thanks to Brian Cameron
* Added detection of readdir_r version
*
* Revision 1.31 2003/09/17 01:18:02 csoutheren
* Removed recursive include file system and removed all references
* to deprecated coooperative threading support
*
* Revision 1.30 2003/03/31 01:23:56 robertj
* Added ReadFrom functions for standard container classes such as
* PIntArray and PStringList etc
*
* Revision 1.29 2002/10/04 01:47:29 robertj
* Added various increment and decrement operators to POrdinalKey.
*
* Revision 1.28 2002/09/16 01:08:59 robertj
* Added #define so can select if #pragma interface/implementation is used on
* platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
*
* Revision 1.27 2002/06/14 13:22:12 robertj
* Fixed ability to remove elements from a PSet by value.
* Added by value add and remove functions to a PSet.
* Added a POrdinalSet class.
* Fixed some documentation.
*
* Revision 1.26 2002/02/06 00:53:25 robertj
* Fixed missing const on PSet::Contains and operator[], thanks Francisco Olarte Sanz
*
* Revision 1.25 1999/11/30 00:22:54 robertj
* Updated documentation for doc++
*
* Revision 1.24 1999/08/22 12:13:43 robertj
* Fixed warning when using inlines on older GNU compiler
*
* Revision 1.23 1999/03/09 02:59:49 robertj
* Changed comments to doc++ compatible documentation.
*
* Revision 1.22 1999/02/16 08:07:11 robertj
* MSVC 6.0 compatibility changes.
*
* Revision 1.21 1998/09/23 06:20:27 robertj
* Added open source copyright license.
*
* Revision 1.20 1998/01/05 10:39:34 robertj
* Fixed "typesafe" templates/macros for dictionaries, especially on GNU.
*
* Revision 1.19 1997/12/11 10:27:16 robertj
* Added type correct Contains() function to dictionaries.
*
* Revision 1.18 1997/07/08 13:15:05 robertj
* DLL support.
*
* Revision 1.17 1997/06/08 04:49:11 robertj
* Fixed non-template class descendent order.
*
* Revision 1.16 1996/08/17 10:00:22 robertj
* Changes for Windows DLL support.
*
* Revision 1.15 1996/03/31 08:44:10 robertj
* Added RemoveAt() function to remove entries from dictionaries.
*
* Revision 1.14 1996/02/08 11:50:01 robertj
* Moved Contains function from PSet to PHashTable so available for dictionaries.
* Added print for dictionaries key=data\n.
* Added GetAt(PINDEX) to template classes to make identical to macro.
*
* Revision 1.13 1996/02/03 11:00:28 robertj
* Temporary removal of SetAt() and GetAt() functions in dictionary macro.
*
* Revision 1.12 1996/01/24 14:43:11 robertj
* Added initialisers to string dictionaries.
*
* Revision 1.11 1996/01/23 13:11:12 robertj
* Mac Metrowerks compiler support.
*
* Revision 1.10 1995/06/17 11:12:29 robertj
* Documentation update.
*
* Revision 1.9 1995/06/04 08:45:57 robertj
* Better C++ compatibility (with BC++)
*
* Revision 1.8 1995/03/14 12:41:19 robertj
* Updated documentation to use HTML codes.
*
* Revision 1.7 1995/02/22 10:50:29 robertj
* Changes required for compiling release (optimised) version.
*
* Revision 1.6 1995/02/11 04:10:35 robertj
* Fixed dictionary MACRO for templates.
*
* Revision 1.5 1995/02/05 00:48:03 robertj
* Fixed template version.
*
* Revision 1.4 1995/01/09 12:35:31 robertj
* Removed unnecesary return value from I/O functions.
* Changes due to Mac port.
*
* Revision 1.3 1994/12/21 11:52:51 robertj
* Documentation and variable normalisation.
*
* Revision 1.2 1994/12/17 01:36:57 robertj
* Fixed memory leak in PStringSet
*
* Revision 1.1 1994/12/12 09:59:32 robertj
* Initial revision
*
*/
#ifdef P_USE_PRAGMA
#pragma interface
#endif
///////////////////////////////////////////////////////////////////////////////
// PDictionary classes
/**This class is used when an ordinal index value is the key for #PSet#
and #PDictionary# classes.
*/
class POrdinalKey : public PObject
{
PCLASSINFO(POrdinalKey, PObject);
public:
/**@name Construction */
//@{
/** Create a new key for ordinal index values.
*/
PINLINE POrdinalKey(
PINDEX newKey = 0 ///< Ordinal index value to use as a key.
);
/**Operator to assign the ordinal.
*/
PINLINE POrdinalKey & operator=(PINDEX);
//@}
/**@name Overrides from class PObject */
//@{
/// Create a duplicate of the POrdinalKey.
virtual PObject * Clone() const;
/* Get the relative rank of the ordinal index. This is a simpel comparison
of the objects PINDEX values.
@return
comparison of the two objects, #EqualTo# for same,
#LessThan# for #obj# logically less than the
object and #GreaterThan# for #obj# logically
greater than the object.
*/
virtual Comparison Compare(const PObject & obj) const;
/**This function calculates a hash table index value for the implementation
of #PSet# and #PDictionary# classes.
@return
hash table bucket number.
*/
virtual PINDEX HashFunction() const;
/**Output the ordinal index to the specified stream. This is identical to
outputting the PINDEX, ie integer, value.
@return
stream that the index was output to.
*/
virtual void PrintOn(ostream & strm) const;
//@}
/**@name New functions for class */
//@{
/** Operator so that a POrdinalKey can be used as a PINDEX value.
*/
PINLINE operator PINDEX() const;
/**Operator to pre-increment the ordinal.
*/
PINLINE PINDEX operator++();
/**Operator to post-increment the ordinal.
*/
PINLINE PINDEX operator++(int);
/**Operator to pre-decrement the ordinal.
*/
PINLINE PINDEX operator--();
/**Operator to post-decrement the ordinal.
*/
PINLINE PINDEX operator--(int);
/**Operator to add the ordinal.
*/
PINLINE POrdinalKey & operator+=(PINDEX);
/**Operator to subtract from the ordinal.
*/
PINLINE POrdinalKey & operator-=(PINDEX );
//@}
private:
PINDEX theKey;
};
//////////////////////////////////////////////////////////////////////////////
/**The hash table class is the basis for implementing the #PSet# and
#PDictionary# classes.
The hash table allows for very fast searches for an object based on a "hash
function". This function yields an index into an array which is directly
looked up to locate the object. When two key values have the same hash
function value, then a linear search of a linked list is made to locate
the object. Thus the efficiency of the hash table is highly dependent on the
quality of the hash function for the data being used as keys.
*/
class PHashTable : public PCollection
{
PCONTAINERINFO(PHashTable, PCollection);
public:
/**@name Construction */
//@{
/// Create a new, empty, hash table.
PHashTable();
//@}
/**@name Overrides from class PObject */
//@{
/**Get the relative rank of the two hash tables. Actally ranking hash
tables is really meaningless, so only equality is returned by the
comparison. Equality is only achieved if the two instances reference the
same hash table.
@return
comparison of the two objects, #EqualTo# if the same
reference and #GreaterThan# if not.
*/
virtual Comparison Compare(
const PObject & obj ///< Other PHashTable to compare against.
) const;
//@}
protected:
/**@name Overrides from class PContainer */
//@{
/**This function is meaningless for hash table. The size of the collection
is determined by the addition and removal of objects. The size cannot be
set in any other way.
@return
Always TRUE.
*/
virtual BOOL SetSize(
PINDEX newSize ///< New size for the hash table, this is ignored.
);
//@}
/**@name New functions for class */
//@{
/**Determine if the value of the object is contained in the hash table. The
object values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
TRUE if the object value is in the set.
*/
PINLINE BOOL AbstractContains(
const PObject & key ///< Key to look for in the set.
) const;
/**Get the key in the hash table at the ordinal index position.
The ordinal position in the hash table is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
This function is primarily used by the descendent template classes, or
macro, with the appropriate type conversion.
@return
reference to key at the index position.
*/
virtual const PObject & AbstractGetKeyAt(
PINDEX index ///< Ordinal position in the hash table.
) const;
/**Get the data in the hash table at the ordinal index position.
The ordinal position in the hash table is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
This function is primarily used by the descendent template classes, or
macro, with the appropriate type conversion.
@return
reference to key at the index position.
*/
virtual PObject & AbstractGetDataAt(
PINDEX index ///< Ordinal position in the hash table.
) const;
//@}
// Member variables
class Element {
public:
friend class Table;
PObject * key;
PObject * data;
Element * next;
Element * prev;
};
PDECLARE_BASEARRAY(Table, Element *)
#ifdef DOC_PLUS_PLUS
{
#endif
public:
virtual ~Table() { Destruct(); }
virtual void DestroyContents();
PINDEX AppendElement(PObject * key, PObject * data);
PObject * RemoveElement(const PObject & key);
BOOL SetLastElementAt(PINDEX index);
Element * GetElementAt(const PObject & key);
PINDEX GetElementsIndex(const PObject*obj,BOOL byVal,BOOL keys) const;
PINDEX lastIndex;
PINDEX lastBucket;
Element * lastElement;
BOOL deleteKeys;
friend class PHashTable;
friend class PAbstractSet;
};
friend class Table;
Table * hashTable;
};
//////////////////////////////////////////////////////////////////////////////
/** Abstract set of PObjects.
*/
class PAbstractSet : public PHashTable
{
PCONTAINERINFO(PAbstractSet, PHashTable);
public:
/**@name Construction */
//@{
/**Create a new, empty, set.
Note that by default, objects placed into the list will be deleted when
removed or when all references to the list are destroyed.
*/
PINLINE PAbstractSet();
//@}
/**@name Overrides from class PCollection */
//@{
/**Add a new object to the collection. If the objects value is already in
the set then the object is {\bf not} included. If the
#AllowDeleteObjects# option is set then the #obj# parameter
is also deleted.
@return
hash function value of the newly added object.
*/
virtual PINDEX Append(
PObject * obj ///< New object to place into the collection.
);
/**Add a new object to the collection. If the objects value is already in
the set then the object is {\bf not} included. If the
AllowDeleteObjects option is set then the #obj# parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
#before# parameter is ignored.
@return
hash function value of the newly added object.
*/
virtual PINDEX Insert(
const PObject & before, ///< Object value to insert before.
PObject * obj ///< New object to place into the collection.
);
/**Add a new object to the collection. If the objects value is already in
the set then the object is {\bf not} included. If the
AllowDeleteObjects option is set then the #obj# parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
#index# parameter is ignored.
@return
hash function value of the newly added object.
*/
virtual PINDEX InsertAt(
PINDEX index, ///< Index position in collection to place the object.
PObject * obj ///< New object to place into the collection.
);
/**Remove the object from the collection. If the AllowDeleteObjects option
is set then the object is also deleted.
Note that the comparison for searching for the object in collection is
made by pointer, not by value. Thus the parameter must point to the
same instance of the object that is in the collection.
@return
TRUE if the object was in the collection.
*/
virtual BOOL Remove(
const PObject * obj ///< Existing object to remove from the collection.
);
/**Remove an object at the specified index. If the #AllowDeleteObjects#
option is set then the object is also deleted.
@return
pointer to the object being removed, or NULL if it was deleted.
*/
virtual PObject * RemoveAt(
PINDEX index ///< Index position in collection to place the object.
);
/**This function is the same as PHashTable::AbstractGetKeyAt().
@return
Always NULL.
*/
virtual PObject * GetAt(
PINDEX index ///< Index position in the collection of the object.
) const;
/**Add a new object to the collection. If the objects value is already in
the set then the object is {\bf not} included. If the
AllowDeleteObjects option is set then the #obj# parameter is
also deleted.
The object is always placed in the an ordinal position dependent on its
hash function. It is not placed at the specified position. The
#index# parameter is ignored.
@return
TRUE if the object was successfully added.
*/
virtual BOOL SetAt(
PINDEX index, ///< Index position in collection to set.
PObject * val ///< New value to place into the collection.
);
/**Search the collection for the specific instance of the object. The
object pointers are compared, not the values. The hash table is used
to locate the entry.
Note that that will require value comparisons to be made to find the
equivalent entry and then a final check is made with the pointers to
see if they are the same instance.
@return
ordinal index position of the object, or P_MAX_INDEX.
*/
virtual PINDEX GetObjectsIndex(
const PObject * obj ///< Object to find.
) const;
/**Search the collection for the specified value of the object. The object
values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
ordinal index position of the object, or P_MAX_INDEX.
*/
virtual PINDEX GetValuesIndex(
const PObject & obj ///< Object to find equal value.
) const;
//@}
};
#ifdef PHAS_TEMPLATES
/**This template class maps the PAbstractSet to a specific object type. The
functions in this class primarily do all the appropriate casting of types.
By default, objects placed into the set will {\bf not} be deleted when
removed or when all references to the set are destroyed. This is different
from the default on most collection classes.
Note that if templates are not used the #PDECLARE_SET# macro will
simulate the template instantiation.
*/
template <class T> class PSet : public PAbstractSet
{
PCLASSINFO(PSet, PAbstractSet);
public:
/**@name Construction */
//@{
/**Create a new, empty, dictionary. The parameter indicates whether to
delete objects that are removed from the set.
Note that by default, objects placed into the set will {\bf not} be
deleted when removed or when all references to the set are destroyed.
This is different from the default on most collection classes.
*/
inline PSet(BOOL initialDeleteObjects = FALSE)
: PAbstractSet() { AllowDeleteObjects(initialDeleteObjects); }
//@}
/**@name Overrides from class PObject */
//@{
/**Make a complete duplicate of the set. Note that all objects in the
array are also cloned, so this will make a complete copy of the set.
*/
virtual PObject * Clone() const
{ return PNEW PSet(0, this); }
//@}
/**@name New functions for class */
//@{
/**Include the specified object into the set. If the objects value is
already in the set then the object is {\bf not} included. If the
AllowDeleteObjects option is set then the #obj# parameter is
also deleted.
The object values are compared, not the pointers. So the objects in
the collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
*/
void Include(
const T * obj // New object to include in the set.
) { Append((PObject *)obj); }
/**Include the specified objects value into the set. If the objects value
is already in the set then the object is {\bf not} included.
The object values are compared, not the pointers. So the objects in
the collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
*/
PSet & operator+=(
const T & obj // New object to include in the set.
) { Append(obj.Clone()); return *this; }
/**Remove the object from the set. If the AllowDeleteObjects option is set
then the object is also deleted.
The object values are compared, not the pointers. So the objects in
the collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
*/
void Exclude(
const T * obj // New object to exclude in the set.
) { Remove(obj); }
/**Remove the objects value from the set. If the AllowDeleteObjects
option is set then the object is also deleted.
The object values are compared, not the pointers. So the objects in
the collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
*/
PSet & operator-=(
const T & obj // New object to exclude in the set.
) { RemoveAt(GetValuesIndex(obj)); return *this; }
/**Determine if the value of the object is contained in the set. The
object values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
TRUE if the object value is in the set.
*/
BOOL Contains(
const T & key ///< Key to look for in the set.
) const { return AbstractContains(key); }
/**Determine if the value of the object is contained in the set. The
object values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
TRUE if the object value is in the set.
*/
BOOL operator[](
const T & key ///< Key to look for in the set.
) const { return AbstractContains(key); }
/**Get the key in the set at the ordinal index position.
The ordinal position in the set is determined by the hash values of the
keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to key at the index position.
*/
virtual const T & GetKeyAt(
PINDEX index ///< Index of value to get.
) const
{ return (const T &)AbstractGetKeyAt(index); }
//@}
protected:
PSet(int dummy, const PSet * c)
: PAbstractSet(dummy, c)
{ reference->deleteObjects = c->reference->deleteObjects; }
};
/**Declare set class.
This macro is used to declare a descendent of PAbstractSet class,
customised for a particular object type {\bf T}. This macro closes the
class declaration off so no additional members can be added.
If the compilation is using templates then this macro produces a typedef
of the #PSet# template class.
See the #PSet# class and #PDECLARE_SET# macro for more
information.
*/
#define PSET(cls, T) typedef PSet<T> cls
/**Begin declaration of a set class.
This macro is used to declare a descendent of PAbstractSet class,
customised for a particular object type {\bf T}.
If the compilation is using templates then this macro produces a descendent
of the #PSet# template class. If templates are not being used then the
macro defines a set of inline functions to do all casting of types. The
resultant classes have an identical set of functions in either case.
See the #PSet# and #PAbstractSet# classes for more information.
*/
#define PDECLARE_SET(cls, T, initDelObj) \
PSET(cls##_PTemplate, T); \
PDECLARE_CLASS(cls, cls##_PTemplate) \
protected: \
cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
cls(BOOL initialDeleteObjects = initDelObj) \
: cls##_PTemplate(initialDeleteObjects) { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
#else // PHAS_TEMPLATES
#define PSET(cls, K) \
class cls : public PAbstractSet { \
PCLASSINFO(cls, PAbstractSet); \
protected: \
inline cls(int dummy, const cls * c) \
: PAbstractSet(dummy, c) \
{ reference->deleteObjects = c->reference->deleteObjects; } \
public: \
inline cls(BOOL initialDeleteObjects = FALSE) \
: PAbstractSet() { AllowDeleteObjects(initialDeleteObjects); } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
inline void Include(const PObject * key) \
{ Append((PObject *)key); } \
inline void Exclude(const PObject * key) \
{ Remove(key); } \
inline BOOL operator[](const K & key) const \
{ return AbstractContains(key); } \
inline BOOL Contains(const K & key) const \
{ return AbstractContains(key); } \
virtual const K & GetKeyAt(PINDEX index) const \
{ return (const K &)AbstractGetKeyAt(index); } \
}
#define PDECLARE_SET(cls, K, initDelObj) \
PSET(cls##_PTemplate, K); \
PDECLARE_CLASS(cls, cls##_PTemplate) \
protected: \
inline cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
inline cls(BOOL initialDeleteObjects = initDelObj) \
: cls##_PTemplate() { AllowDeleteObjects(initialDeleteObjects); } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
#endif // PHAS_TEMPLATES
PSET(POrdinalSet, POrdinalKey);
//////////////////////////////////////////////////////////////////////////////
/**An abstract dictionary container.
*/
class PAbstractDictionary : public PHashTable
{
PCLASSINFO(PAbstractDictionary, PHashTable);
public:
/**@name Construction */
//@{
/**Create a new, empty, dictionary.
Note that by default, objects placed into the dictionary will be deleted
when removed or when all references to the dictionary are destroyed.
*/
PINLINE PAbstractDictionary();
//@}
/**@name Overrides from class PObject */
//@{
/**Output the contents of the object to the stream. The exact output is
dependent on the exact semantics of the descendent class. This is
primarily used by the standard ##operator<<## function.
The default behaviour is to print the class name.
*/
virtual void PrintOn(
ostream &strm ///< Stream to print the object into.
) const;
//@}
/**@name Overrides from class PCollection */
//@{
/**Insert a new object into the dictionary. The semantics of this function
is different from that of the #PCollection# class. This function is
exactly equivalent to the SetAt() function that sets a data value at
the key value location.
@return
Always zero.
*/
virtual PINDEX Insert(
const PObject & key, ///< Object value to use as the key.
PObject * obj ///< New object to place into the collection.
);
/**Insert a new object at the specified index. The index is as is used in
the #GetKeyAt()# function.
@return
#index# parameter.
*/
virtual PINDEX InsertAt(
PINDEX index, ///< Index position in collection to place the object.
PObject * obj ///< New object to place into the collection.
);
/**Remove an object at the specified index. The index is as is used in
the #GetKeyAt()# function. The returned pointer is then removed using
the #SetAt()# function to set that key value to NULL. If the
#AllowDeleteObjects# option is set then the object is also
deleted.
@return
pointer to the object being removed, or NULL if it was deleted.
*/
virtual PObject * RemoveAt(
PINDEX index ///< Index position in collection to place the object.
);
/**Set the object at the specified index to the new value. The index is
as is used in the #GetKeyAt()# function. This will overwrite the
existing entry. If the AllowDeleteObjects option is set then the old
object is also deleted.
@return
TRUE if the object was successfully added.
*/
virtual BOOL SetAt(
PINDEX index, ///< Index position in collection to set.
PObject * val ///< New value to place into the collection.
);
/**Get the object at the specified index position. The index is as is
used in the #GetKeyAt()# function. If the index was not in the
collection then NULL is returned.
@return
pointer to object at the specified index.
*/
virtual PObject * GetAt(
PINDEX index ///< Index position in the collection of the object.
) const;
/**Search the collection for the specific instance of the object. The
object pointers are compared, not the values. The hash table is used
to locate the entry.
Note that that will require value comparisons to be made to find the
equivalent entry and then a final check is made with the pointers to
see if they are the same instance.
@return
ordinal index position of the object, or P_MAX_INDEX.
*/
virtual PINDEX GetObjectsIndex(
const PObject * obj ///< Object to find.
) const;
/**Search the collection for the specified value of the object. The object
values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
ordinal index position of the object, or P_MAX_INDEX.
*/
virtual PINDEX GetValuesIndex(
const PObject & obj ///< Object to find value of.
) const;
//@}
/**@name New functions for class */
//@{
/**Set the data at the specified ordinal index position in the dictionary.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
@return
TRUE if the new object could be placed into the dictionary.
*/
virtual BOOL SetDataAt(
PINDEX index, ///< Ordinal index in the dictionary.
PObject * obj ///< New object to put into the dictionary.
);
/**Add a new object to the collection. If the objects value is already in
the dictionary then the object is overrides the previous value. If the
AllowDeleteObjects option is set then the old object is also deleted.
The object is placed in the an ordinal position dependent on the keys
hash function. Subsequent searches use the has function to speed access
to the data item.
@return
TRUE if the object was successfully added.
*/
virtual BOOL AbstractSetAt(
const PObject & key, ///< Key for position in dictionary to add object.
PObject * obj ///< New object to put into the dictionary.
);
/**Get the object at the specified key position. If the key was not in the
collection then this function asserts.
This function is primarily for use by the #operator[]# function is
descendent template classes.
@return
reference to object at the specified key.
*/
virtual PObject & GetRefAt(
const PObject & key ///< Key for position in dictionary to get object.
) const;
/**Get the object at the specified key position. If the key was not in the
collection then NULL is returned.
@return
pointer to object at the specified key.
*/
virtual PObject * AbstractGetAt(
const PObject & key ///< Key for position in dictionary to get object.
) const;
//@}
protected:
PINLINE PAbstractDictionary(int dummy, const PAbstractDictionary * c);
private:
virtual PINDEX Append(
PObject * obj // New object to place into the collection.
);
/* This function is meaningless and will assert.
@return
Always zero.
*/
virtual BOOL Remove(
const PObject * obj // Existing object to remove from the collection.
);
/* Remove the object from the collection. If the AllowDeleteObjects option
is set then the object is also deleted.
Note that the comparison for searching for the object in collection is
made by pointer, not by value. Thus the parameter must point to the
same instance of the object that is in the collection.
@return
TRUE if the object was in the collection.
*/
};
#ifdef PHAS_TEMPLATES
/**This template class maps the PAbstractDictionary to a specific key and data
types. The functions in this class primarily do all the appropriate casting
of types.
Note that if templates are not used the #PDECLARE_DICTIONARY# macro
will simulate the template instantiation.
*/
template <class K, class D> class PDictionary : public PAbstractDictionary
{
PCLASSINFO(PDictionary, PAbstractDictionary);
public:
/**@name Construction */
//@{
/**Create a new, empty, dictionary.
Note that by default, objects placed into the dictionary will be
deleted when removed or when all references to the dictionary are
destroyed.
*/
PDictionary()
: PAbstractDictionary() { }
//@}
/**@name Overrides from class PObject */
//@{
/**Make a complete duplicate of the dictionary. Note that all objects in
the array are also cloned, so this will make a complete copy of the
dictionary.
*/
virtual PObject * Clone() const
{ return PNEW PDictionary(0, this); }
//@}
/**@name New functions for class */
//@{
/**Get the object contained in the dictionary at the #key#
position. The hash table is used to locate the data quickly via the
hash function provided by the #key#.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to the object indexed by the key.
*/
D & operator[](
const K & key ///< Key to look for in the dictionary.
) const
{ return (D &)GetRefAt(key); }
/**Determine if the value of the object is contained in the hash table. The
object values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
TRUE if the object value is in the dictionary.
*/
BOOL Contains(
const K & key ///< Key to look for in the dictionary.
) const { return AbstractContains(key); }
/**Remove an object at the specified key. The returned pointer is then
removed using the #SetAt()# function to set that key value to
NULL. If the #AllowDeleteObjects# option is set then the
object is also deleted.
@return
pointer to the object being removed, or NULL if the key was not
present in the dictionary. If the dictionary is set to delete objects
upon removal, the value -1 is returned if the key existed prior to removal
rather than returning an illegal pointer
*/
virtual D * RemoveAt(
const K & key ///< Key for position in dictionary to get object.
) {
D * obj = GetAt(key); AbstractSetAt(key, NULL);
return reference->deleteObjects ? (obj ? (D *)-1 : NULL) : obj;
}
/**Add a new object to the collection. If the objects value is already in
the dictionary then the object is overrides the previous value. If the
AllowDeleteObjects option is set then the old object is also deleted.
The object is placed in the an ordinal position dependent on the keys
hash function. Subsequent searches use the has function to speed access
to the data item.
@return
TRUE if the object was successfully added.
*/
virtual BOOL SetAt(
const K & key, // Key for position in dictionary to add object.
D * obj // New object to put into the dictionary.
) { return AbstractSetAt(key, obj); }
/**Get the object at the specified key position. If the key was not in the
collection then NULL is returned.
@return
pointer to object at the specified key.
*/
virtual D * GetAt(
const K & key // Key for position in dictionary to get object.
) const { return (D *)AbstractGetAt(key); }
/**Get the key in the dictionary at the ordinal index position.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to key at the index position.
*/
const K & GetKeyAt(
PINDEX index ///< Ordinal position in dictionary for key.
) const
{ return (const K &)AbstractGetKeyAt(index); }
/**Get the data in the dictionary at the ordinal index position.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to data at the index position.
*/
D & GetDataAt(
PINDEX index ///< Ordinal position in dictionary for data.
) const
{ return (D &)AbstractGetDataAt(index); }
//@}
protected:
PDictionary(int dummy, const PDictionary * c)
: PAbstractDictionary(dummy, c) { }
};
/**Declare a dictionary class.
This macro is used to declare a descendent of PAbstractDictionary class,
customised for a particular key type {\bf K} and data object type {\bf D}.
This macro closes the class declaration off so no additional members can
be added.
If the compilation is using templates then this macro produces a typedef
of the #PDictionary# template class.
See the #PDictionary# class and #PDECLARE_DICTIONARY# macro for
more information.
*/
#define PDICTIONARY(cls, K, D) typedef PDictionary<K, D> cls
/**Begin declaration of dictionary class.
This macro is used to declare a descendent of PAbstractDictionary class,
customised for a particular key type {\bf K} and data object type {\bf D}.
If the compilation is using templates then this macro produces a descendent
of the #PDictionary# template class. If templates are not being used
then the macro defines a set of inline functions to do all casting of types.
The resultant classes have an identical set of functions in either case.
See the #PDictionary# and #PAbstractDictionary# classes for more
information.
*/
#define PDECLARE_DICTIONARY(cls, K, D) \
PDICTIONARY(cls##_PTemplate, K, D); \
PDECLARE_CLASS(cls, cls##_PTemplate) \
protected: \
cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
cls() \
: cls##_PTemplate() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
/**This template class maps the #PAbstractDictionary# to a specific key
type and a #POrdinalKey# data type. The functions in this class
primarily do all the appropriate casting of types.
Note that if templates are not used the #PDECLARE_ORDINAL_DICTIONARY#
macro will simulate the template instantiation.
*/
template <class K> class POrdinalDictionary : public PAbstractDictionary
{
PCLASSINFO(POrdinalDictionary, PAbstractDictionary);
public:
/**@name Construction */
//@{
/**Create a new, empty, dictionary.
Note that by default, objects placed into the dictionary will be
deleted when removed or when all references to the dictionary are
destroyed.
*/
POrdinalDictionary()
: PAbstractDictionary() { }
//@}
/**@name Overrides from class PObject */
//@{
/**Make a complete duplicate of the dictionary. Note that all objects in
the array are also cloned, so this will make a complete copy of the
dictionary.
*/
virtual PObject * Clone() const
{ return PNEW POrdinalDictionary(0, this); }
//@}
/**@name New functions for class */
//@{
/**Get the object contained in the dictionary at the #key#
position. The hash table is used to locate the data quickly via the
hash function provided by the key.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to the object indexed by the key.
*/
PINDEX operator[](
const K & key // Key to look for in the dictionary.
) const
{ return (POrdinalKey &)GetRefAt(key); }
/**Determine if the value of the object is contained in the hash table. The
object values are compared, not the pointers. So the objects in the
collection must correctly implement the #PObject::Compare()#
function. The hash table is used to locate the entry.
@return
TRUE if the object value is in the dictionary.
*/
BOOL Contains(
const K & key ///< Key to look for in the dictionary.
) const { return AbstractContains(key); }
virtual POrdinalKey * GetAt(
const K & key ///< Key for position in dictionary to get object.
) const { return (POrdinalKey *)AbstractGetAt(key); }
/* Get the object at the specified key position. If the key was not in the
collection then NULL is returned.
@return
pointer to object at the specified key.
*/
/**Set the data at the specified ordinal index position in the dictionary.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
@return
TRUE if the new object could be placed into the dictionary.
*/
virtual BOOL SetDataAt(
PINDEX index, ///< Ordinal index in the dictionary.
PINDEX ordinal ///< New ordinal value to put into the dictionary.
) { return PAbstractDictionary::SetDataAt(index, PNEW POrdinalKey(ordinal)); }
/**Add a new object to the collection. If the objects value is already in
the dictionary then the object is overrides the previous value. If the
AllowDeleteObjects option is set then the old object is also deleted.
The object is placed in the an ordinal position dependent on the keys
hash function. Subsequent searches use the has function to speed access
to the data item.
@return
TRUE if the object was successfully added.
*/
virtual BOOL SetAt(
const K & key, ///< Key for position in dictionary to add object.
PINDEX ordinal ///< New ordinal value to put into the dictionary.
) { return AbstractSetAt(key, PNEW POrdinalKey(ordinal)); }
/**Remove an object at the specified key. The returned pointer is then
removed using the #SetAt()# function to set that key value to
NULL. If the #AllowDeleteObjects# option is set then the
object is also deleted.
@return
pointer to the object being removed, or NULL if it was deleted.
*/
virtual PINDEX RemoveAt(
const K & key ///< Key for position in dictionary to get object.
) { PINDEX ord = *GetAt(key); AbstractSetAt(key, NULL); return ord; }
/**Get the key in the dictionary at the ordinal index position.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to key at the index position.
*/
const K & GetKeyAt(
PINDEX index ///< Ordinal position in dictionary for key.
) const
{ return (const K &)AbstractGetKeyAt(index); }
/**Get the data in the dictionary at the ordinal index position.
The ordinal position in the dictionary is determined by the hash values
of the keys and the order of insertion.
The last key/data pair is remembered by the class so that subseqent
access is very fast.
@return
reference to data at the index position.
*/
PINDEX GetDataAt(
PINDEX index ///< Ordinal position in dictionary for data.
) const
{ return (POrdinalKey &)AbstractGetDataAt(index); }
//@}
protected:
POrdinalDictionary(int dummy, const POrdinalDictionary * c)
: PAbstractDictionary(dummy, c) { }
};
/**Declare an ordinal dictionary class.
This macro is used to declare a descendent of PAbstractDictionary class,
customised for a particular key type {\bf K} and data object type of
#POrdinalKey#. This macro closes the class declaration off so no
additional members can be added.
If the compilation is using templates then this macro produces a typedef
of the #POrdinalDictionary# template class.
See the #POrdinalDictionary# class and
#PDECLARE_ORDINAL_DICTIONARY# macro for more information.
*/
#define PORDINAL_DICTIONARY(cls, K) typedef POrdinalDictionary<K> cls
/**Begin declaration of an ordinal dictionary class.
This macro is used to declare a descendent of PAbstractList class,
customised for a particular key type {\bf K} and data object type of
#POrdinalKey#.
If the compilation is using templates then this macro produces a descendent
of the #POrdinalDictionary# template class. If templates are not being
used then the macro defines a set of inline functions to do all casting of
types. The resultant classes have an identical set of functions in either
case.
See the #POrdinalDictionary# and #PAbstractDictionary# classes
for more information.
*/
#define PDECLARE_ORDINAL_DICTIONARY(cls, K) \
PORDINAL_DICTIONARY(cls##_PTemplate, K); \
PDECLARE_CLASS(cls, POrdinalDictionary<K>) \
protected: \
cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
cls() \
: cls##_PTemplate() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
#else // PHAS_TEMPLATES
#define PDICTIONARY(cls, K, D) \
class cls : public PAbstractDictionary { \
PCLASSINFO(cls, PAbstractDictionary); \
protected: \
inline cls(int dummy, const cls * c) \
: PAbstractDictionary(dummy, c) { } \
public: \
cls() \
: PAbstractDictionary() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
D & operator[](const K & key) const \
{ return (D &)GetRefAt(key); } \
virtual BOOL Contains(const K & key) const \
{ return AbstractContains(key); } \
virtual D * RemoveAt(const K & key) \
{ D * obj = GetAt(key); AbstractSetAt(key, NULL); return obj; } \
virtual BOOL SetAt(const K & key, D * obj) \
{ return AbstractSetAt(key, obj); } \
virtual D * GetAt(const K & key) const \
{ return (D *)AbstractGetAt(key); } \
const K & GetKeyAt(PINDEX index) const \
{ return (const K &)AbstractGetKeyAt(index); } \
D & GetDataAt(PINDEX index) const \
{ return (D &)AbstractGetDataAt(index); } \
}
#define PDECLARE_DICTIONARY(cls, K, D) \
PDICTIONARY(cls##_PTemplate, K, D); \
PDECLARE_CLASS(cls, cls##_PTemplate) \
protected: \
cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
cls() \
: cls##_PTemplate() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
#define PORDINAL_DICTIONARY(cls, K) \
class cls : public PAbstractDictionary { \
PCLASSINFO(cls, PAbstractDictionary); \
protected: \
inline cls(int dummy, const cls * c) \
: PAbstractDictionary(dummy, c) { } \
public: \
inline cls() \
: PAbstractDictionary() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
inline PINDEX operator[](const K & key) const \
{ return (POrdinalKey &)GetRefAt(key); } \
virtual BOOL Contains(const K & key) const \
{ return AbstractContains(key); } \
virtual POrdinalKey * GetAt(const K & key) const \
{ return (POrdinalKey *)AbstractGetAt(key); } \
virtual BOOL SetDataAt(PINDEX index, PINDEX ordinal) \
{ return PAbstractDictionary::SetDataAt(index, PNEW POrdinalKey(ordinal)); } \
virtual BOOL SetAt(const K & key, PINDEX ordinal) \
{ return AbstractSetAt(key, PNEW POrdinalKey(ordinal)); } \
virtual PINDEX RemoveAt(const K & key) \
{ PINDEX ord = *GetAt(key); AbstractSetAt(key, NULL); return ord; } \
inline const K & GetKeyAt(PINDEX index) const \
{ return (const K &)AbstractGetKeyAt(index); } \
inline PINDEX GetDataAt(PINDEX index) const \
{ return (POrdinalKey &)AbstractGetDataAt(index); } \
}
#define PDECLARE_ORDINAL_DICTIONARY(cls, K) \
PORDINAL_DICTIONARY(cls##_PTemplate, K); \
PDECLARE_CLASS(cls, cls##_PTemplate) \
protected: \
cls(int dummy, const cls * c) \
: cls##_PTemplate(dummy, c) { } \
public: \
cls() \
: cls##_PTemplate() { } \
virtual PObject * Clone() const \
{ return PNEW cls(0, this); } \
#endif // PHAS_TEMPLATES
// End Of File ///////////////////////////////////////////////////////////////
|