WINGs/WINGs/WUtil.h

   1 #ifndef _WUTIL_H_
   2 #define _WUTIL_H_
   3
   4 #include <X11/Xlib.h>
   5 #include <limits.h>
   6 #include <sys/types.h>
   7
   8 /* SunOS 4.x Blargh.... */
   9 #ifndef NULL
  10 #define NULL ((void*)0)
  11 #endif
  12
  13 /*
  14  * Warning: proplist.h #defines BOOL which will clash with the
  15  * typedef BOOL in Xmd.h
  16  * proplist.h should use Bool (which is a #define in Xlib.h) instead.
  17  *
  18  */
  19 #include <proplist.h>
  20
  21
  22 #ifndef WMAX
  23 # define WMAX(a,b)      ((a)>(b) ? (a) : (b))
  24 #endif
  25 #ifndef WMIN
  26 # define WMIN(a,b)      ((a)<(b) ? (a) : (b))
  27 #endif
  28
  29
  30 #if (!defined (__GNUC__) || __GNUC__ < 2 || \
  31      __GNUC_MINOR__ < (defined (__cplusplus) ? 6 : 4))
  32 #define __ASSERT_FUNCTION       ((char *) 0)
  33 #else
  34 #define __ASSERT_FUNCTION       __PRETTY_FUNCTION__
  35 #endif
  36
  37
  38 #ifdef NDEBUG
  39
  40 #define wassertr(expr)          {}
  41 #define wassertrv(expr, val)    {}
  42
  43 #else /* !NDEBUG */
  44
  45 #ifdef DEBUG
  46
  47 #include <assert.h>
  48
  49 #define wassertr(expr)  assert(expr)
  50
  51 #define wassertrv(expr, val)    assert(expr)
  52
  53 #else /* !DEBUG */
  54
  55 #define wassertr(expr) \
  56         if (!(expr)) { \
  57                 wwarning("%s line %i (%s): assertion %s failed",\
  58                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  59                 return;\
  60         }
  61
  62 #define wassertrv(expr, val) \
  63         if (!(expr)) { \
  64                 wwarning("%s line %i (%s): assertion %s failed",\
  65                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  66                 return (val);\
  67         }
  68 #endif /* !DEBUG */
  69
  70 #endif /* !NDEBUG */
  71
  72
  73 #ifdef __cplusplus
  74 extern "C" {
  75 #endif /* __cplusplus */
  76
  77
  78 typedef enum {
  79     WMPostWhenIdle = 1,
  80         WMPostASAP = 2,
  81         WMPostNow = 3
  82 } WMPostingStyle;
  83
  84
  85 typedef enum {
  86     WNCNone = 0,
  87         WNCOnName = 1,
  88         WNCOnSender = 2
  89 } WMNotificationCoalescing;
  90
  91
  92 /* The possible states for connections */
  93 typedef enum {
  94     WCNotConnected=0,
  95     WCListening,
  96     WCInProgress,
  97     WCFailed,
  98     WCConnected,
  99     WCTimedOut,
 100     WCDied,
 101     WCClosed
 102 } WMConnectionState;
 103
 104
 105 /* The possible states for connection timeouts */
 106 typedef enum {
 107     WCTNone=0,
 108     WCTWhileOpening,
 109     WCTWhileSending
 110 } WMConnectionTimeoutState;
 111
 112
 113
 114 enum {
 115     WBNotFound = INT_MIN, /* element was not found in WMBag   */
 116     WANotFound = -1       /* element was not found in WMArray */
 117 };
 118
 119
 120 typedef struct W_Array WMArray;
 121 typedef struct W_Bag WMBag;
 122 typedef struct W_Data WMData;
 123 typedef struct W_TreeNode WMTreeNode;
 124 typedef struct W_HashTable WMHashTable;
 125 typedef struct W_UserDefaults WMUserDefaults;
 126 typedef struct W_Notification WMNotification;
 127 typedef struct W_NotificationQueue WMNotificationQueue;
 128 typedef struct W_Host WMHost;
 129 typedef struct W_Connection WMConnection;
 130 typedef struct W_PropList WMPropList;
 131
 132
 133
 134 /* Some typedefs for the handler stuff */
 135 typedef void *WMHandlerID;
 136
 137 typedef void WMCallback(void *data);
 138
 139 typedef void WMInputProc(int fd, int mask, void *clientData);
 140
 141
 142
 143 typedef int WMCompareDataProc(const void *item1, const void *item2);
 144
 145 typedef void WMFreeDataProc(void *data);
 146
 147 /* Used by WMBag or WMArray for matching data */
 148 typedef int WMMatchDataProc(void *item, void *cdata);
 149
 150
 151
 152 typedef struct {
 153     int position;
 154     int count;
 155 } WMRange;
 156
 157
 158
 159 /* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
 160 typedef struct {
 161     void *table;
 162     void *nextItem;
 163     int index;
 164 } WMHashEnumerator;
 165
 166
 167 typedef struct {
 168     /* NULL is pointer hash */
 169     unsigned    (*hash)(const void *);
 170     /* NULL is pointer compare */
 171     Bool        (*keyIsEqual)(const void *, const void *);
 172     /* NULL does nothing */
 173     void*       (*retainKey)(const void *);
 174     /* NULL does nothing */
 175     void        (*releaseKey)(const void *);
 176 } WMHashTableCallbacks;
 177
 178
 179 typedef int WMArrayIterator;
 180 typedef void *WMBagIterator;
 181
 182
 183 #if 0
 184 typedef struct {
 185     char character;                    /* the escape character */
 186     char *value;                       /* value to place */
 187 } WMSEscapes;
 188 #endif
 189
 190
 191 /* The connection callbacks */
 192 typedef struct ConnectionDelegate {
 193     void *data;
 194
 195     void (*didCatchException)(struct ConnectionDelegate *self,
 196                               WMConnection *cPtr);
 197
 198     void (*didDie)(struct ConnectionDelegate *self, WMConnection *cPtr);
 199
 200     void (*didInitialize)(struct ConnectionDelegate *self, WMConnection *cPtr);
 201
 202     void (*didReceiveInput)(struct ConnectionDelegate *self, WMConnection *cPtr);
 203
 204     void (*didTimeout)(struct ConnectionDelegate *self, WMConnection *cPtr);
 205
 206 } ConnectionDelegate;
 207
 208
 209 typedef void WMNotificationObserverAction(void *observerData,
 210                                           WMNotification *notification);
 211
 212
 213
 214 /*......................................................................*/
 215
 216 typedef void (waborthandler)(int);
 217
 218 waborthandler* wsetabort(waborthandler*);
 219
 220
 221 /* don't free the returned string */
 222 char* wstrerror(int errnum);
 223
 224 void wmessage(const char *msg, ...);
 225 void wwarning(const char *msg, ...);
 226 void wfatal(const char *msg, ...);
 227 void wsyserror(const char *msg, ...);
 228 void wsyserrorwithcode(int error, const char *msg, ...);
 229
 230 char* wfindfile(char *paths, char *file);
 231
 232 char* wfindfileinlist(char **path_list, char *file);
 233
 234 char* wfindfileinarray(proplist_t array, char *file);
 235
 236 char* wexpandpath(char *path);
 237
 238 /* don't free the returned string */
 239 char* wgethomedir();
 240
 241 void* wmalloc(size_t size);
 242 void* wrealloc(void *ptr, size_t newsize);
 243 void wfree(void *ptr);
 244
 245
 246 void wrelease(void *ptr);
 247 void* wretain(void *ptr);
 248
 249 char* wstrdup(char *str);
 250
 251 /* Concatenate str1 with str2 and return that in a newly malloc'ed string.
 252  * str1 and str2 can be any strings including static and constant strings.
 253  * str1 and str2 will not be modified.
 254  * Free the returned string when you're done with it. */
 255 char* wstrconcat(char *str1, char *str2);
 256
 257 /* This will append src to dst, and return dst. dst MUST be either NULL
 258  * or a string that was a result of a dynamic allocation (malloc, realloc
 259  * wmalloc, wrealloc, ...). dst CANNOT be a static or a constant string!
 260  * Modifies dst (no new string is created except if dst==NULL in which case
 261  * it is equivalent to calling wstrdup(src) ).
 262  * The returned address may be different from the original address of dst,
 263  * so always assign the returned address to avoid dangling pointers. */
 264 char* wstrappend(char *dst, char *src);
 265
 266
 267 void wtokensplit(char *command, char ***argv, int *argc);
 268
 269 char* wtokennext(char *word, char **next);
 270
 271 char* wtokenjoin(char **list, int count);
 272
 273 void wtokenfree(char **tokens, int count);
 274
 275 char* wtrimspace(char *s);
 276
 277
 278 WMRange wmkrange(int start, int count);
 279 #ifdef ANSI_C_DOESNT_LIKE_IT_THIS_WAY
 280 #define wmkrange(position, count) (WMRange){(position), (count)}
 281 #endif
 282
 283
 284 char* wusergnusteppath();
 285
 286 char* wdefaultspathfordomain(char *domain);
 287
 288 void wusleep(unsigned int microsec);
 289
 290 #if 0
 291 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 292                int count);
 293 #endif
 294
 295 /*......................................................................*/
 296
 297 /* Event handlers: timer, idle, input */
 298
 299 WMHandlerID WMAddTimerHandler(int milliseconds, WMCallback *callback,
 300                               void *cdata);
 301
 302 WMHandlerID WMAddPersistentTimerHandler(int milliseconds, WMCallback *callback,
 303                                         void *cdata);
 304
 305 void WMDeleteTimerWithClientData(void *cdata);
 306
 307 void WMDeleteTimerHandler(WMHandlerID handlerID);
 308
 309 WMHandlerID WMAddIdleHandler(WMCallback *callback, void *cdata);
 310
 311 void WMDeleteIdleHandler(WMHandlerID handlerID);
 312
 313 WMHandlerID WMAddInputHandler(int fd, int condition, WMInputProc *proc,
 314                               void *clientData);
 315
 316 void WMDeleteInputHandler(WMHandlerID handlerID);
 317
 318
 319 /* This function is used _only_ if you create a non-GUI program.
 320  * For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
 321  * This function will handle all input/timer/idle events, then return.
 322  */
 323
 324 void WHandleEvents();
 325
 326 /*......................................................................*/
 327
 328
 329 WMHashTable* WMCreateHashTable(WMHashTableCallbacks callbacks);
 330
 331 void WMFreeHashTable(WMHashTable *table);
 332
 333 void WMResetHashTable(WMHashTable *table);
 334
 335 unsigned WMCountHashTable(WMHashTable *table);
 336
 337 void* WMHashGet(WMHashTable *table, const void *key);
 338
 339 /* put data in table, replacing already existing data and returning
 340  * the old value */
 341 void* WMHashInsert(WMHashTable *table, const void *key, const void *data);
 342
 343 void WMHashRemove(WMHashTable *table, const void *key);
 344
 345 /* warning: do not manipulate the table while using the enumerator functions */
 346 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 347
 348 void* WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 349
 350 void* WMNextHashEnumeratorKey(WMHashEnumerator *enumerator);
 351
 352 /* Returns True if there is a next element, in which case key and item
 353  * will contain the next element's key and value respectively.
 354  * If there is no next element available it will return False and in this
 355  * case key and item will be undefined.
 356  */
 357 Bool WMNextHashEnumeratorItemAndKey(WMHashEnumerator *enumerator,
 358                                     void **item, void **key);
 359
 360
 361
 362
 363 /* some predefined callback sets */
 364
 365 extern const WMHashTableCallbacks WMIntHashCallbacks;
 366 /* sizeof(keys) are <= sizeof(void*) */
 367
 368 extern const WMHashTableCallbacks WMStringHashCallbacks;
 369 /* keys are strings. Strings will be copied with wstrdup()
 370  * and freed with wfree() */
 371
 372 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 373 /* keys are strings, bug they are not copied */
 374
 375
 376 /*......................................................................*/
 377
 378 /*
 379  * WMArray use an array to store the elements.
 380  * Item indexes may be only positive integer numbers.
 381  * The array cannot contain holes in it.
 382  *
 383  * Pros:
 384  * Fast [O(1)] access to elements
 385  * Fast [O(1)] push/pop
 386  *
 387  * Cons:
 388  * A little slower [O(n)] for insertion/deletion of elements that
 389  *      aren't in the end
 390  */
 391
 392 WMArray* WMCreateArray(int initialSize);
 393
 394 WMArray* WMCreateArrayWithDestructor(int initialSize, WMFreeDataProc *destructor);
 395
 396 WMArray* WMCreateArrayWithArray(WMArray *array);
 397
 398 #define WMDuplicateArray(array) WMCreateArrayWithArray(array)
 399
 400 void WMEmptyArray(WMArray *array);
 401
 402 void WMFreeArray(WMArray *array);
 403
 404 int WMGetArrayItemCount(WMArray *array);
 405
 406 /* appends other to array. other remains unchanged */
 407 void WMAppendArray(WMArray *array, WMArray *other);
 408
 409 /* add will place the element at the end of the array */
 410 void WMAddToArray(WMArray *array, void *item);
 411
 412 #define WMPushInArray(array, item) WMAddToArray(array, item)
 413
 414 /* insert will increment the index of elements after it by 1 */
 415 void WMInsertInArray(WMArray *array, int index, void *item);
 416
 417 /* replace and set will return the old item WITHOUT calling the
 418  * destructor on it even if its available. Free the returned item yourself.
 419  */
 420 void* WMReplaceInArray(WMArray *array, int index, void *item);
 421
 422 #define WMSetInArray(array, index, item) WMReplaceInArray(array, index, item)
 423
 424 /* delete and remove will remove the elements and cause the elements
 425  * after them to decrement their indexes by 1. Also will call the
 426  * destructor on the deleted element if there's one available.
 427  */
 428 int WMDeleteFromArray(WMArray *array, int index);
 429
 430 #define WMRemoveFromArray(array, item) WMRemoveFromArrayMatching(array, NULL, item)
 431
 432 int WMRemoveFromArrayMatching(WMArray *array, WMMatchDataProc *match, void *cdata);
 433
 434 void* WMGetFromArray(WMArray *array, int index);
 435
 436 #define WMGetFirstInArray(array, item) WMFindInArray(array, NULL, item)
 437
 438 /* pop will return the last element from the array, also removing it
 439  * from the array. The destructor is NOT called, even if available.
 440  * Free the returned element if needed by yourself
 441  */
 442 void* WMPopFromArray(WMArray *array);
 443
 444 int WMFindInArray(WMArray *array, WMMatchDataProc *match, void *cdata);
 445
 446 int WMCountInArray(WMArray *array, void *item);
 447
 448 /* comparer must return:
 449  * < 0 if a < b
 450  * > 0 if a > b
 451  * = 0 if a = b
 452  */
 453 void WMSortArray(WMArray *array, WMCompareDataProc *comparer);
 454
 455 void WMMapArray(WMArray *array, void (*function)(void*, void*), void *data);
 456
 457 WMArray* WMGetSubarrayWithRange(WMArray* array, WMRange aRange);
 458
 459 void* WMArrayFirst(WMArray *array, WMArrayIterator *iter);
 460
 461 void* WMArrayLast(WMArray *array, WMArrayIterator *iter);
 462
 463 /* The following 2 functions assume that the array doesn't change between calls */
 464 void* WMArrayNext(WMArray *array, WMArrayIterator *iter);
 465
 466 void* WMArrayPrevious(WMArray *array, WMArrayIterator *iter);
 467
 468
 469 /* The following 2 macros assume that the array doesn't change in the for loop */
 470 #define WM_ITERATE_ARRAY(array, var, i) \
 471         for (var = WMArrayFirst(array, &(i)); (i) != WANotFound; \
 472                 var = WMArrayNext(array, &(i)))
 473
 474 #define WM_ETARETI_ARRAY(array, var, i) \
 475         for (var = WMArrayLast(array, &(i)); (i) != WANotFound; \
 476                 var = WMArrayPrevious(array, &(i)))
 477
 478 /*..........................................................................*/
 479
 480 /*
 481  * Tree bags use a red-black tree for storage.
 482  * Item indexes may be any integer number.
 483  *
 484  * Pros:
 485  * O(lg n) insertion/deletion/search
 486  * Good for large numbers of elements with sparse indexes
 487  *
 488  * Cons:
 489  * O(lg n) insertion/deletion/search
 490  * Slow for storing small numbers of elements
 491  */
 492
 493 #define WMCreateBag(size) WMCreateTreeBag()
 494
 495 #define WMCreateBagWithDestructor(size, d) WMCreateTreeBagWithDestructor(d)
 496
 497 WMBag* WMCreateTreeBag(void);
 498
 499 WMBag* WMCreateTreeBagWithDestructor(WMFreeDataProc *destructor);
 500
 501 int WMGetBagItemCount(WMBag *bag);
 502
 503 void WMAppendBag(WMBag *bag, WMBag *other);
 504
 505 void WMPutInBag(WMBag *bag, void *item);
 506
 507 /* insert will increment the index of elements after it by 1 */
 508 void WMInsertInBag(WMBag *bag, int index, void *item);
 509
 510 /* erase will remove the element from the bag,
 511  * but will keep the index of the other elements unchanged */
 512 int WMEraseFromBag(WMBag *bag, int index);
 513
 514 /* delete and remove will remove the elements and cause the elements
 515  * after them to decrement their indexes by 1 */
 516 int WMDeleteFromBag(WMBag *bag, int index);
 517
 518 int WMRemoveFromBag(WMBag *bag, void *item);
 519
 520 void* WMGetFromBag(WMBag *bag, int index);
 521
 522 void* WMReplaceInBag(WMBag *bag, int index, void *item);
 523
 524 #define WMSetInBag(bag, index, item) WMReplaceInBag(bag, index, item)
 525
 526 /* comparer must return:
 527  * < 0 if a < b
 528  * > 0 if a > b
 529  * = 0 if a = b
 530  */
 531 void WMSortBag(WMBag *bag, WMCompareDataProc *comparer);
 532
 533 void WMEmptyBag(WMBag *bag);
 534
 535 void WMFreeBag(WMBag *bag);
 536
 537 void WMMapBag(WMBag *bag, void (*function)(void*, void*), void *data);
 538
 539 int WMGetFirstInBag(WMBag *bag, void *item);
 540
 541 int WMCountInBag(WMBag *bag, void *item);
 542
 543 int WMFindInBag(WMBag *bag, WMMatchDataProc *match, void *cdata);
 544
 545 void* WMBagFirst(WMBag *bag, WMBagIterator *ptr);
 546
 547 void* WMBagLast(WMBag *bag, WMBagIterator *ptr);
 548
 549 /* The following 4 functions assume that the bag doesn't change between calls */
 550 void* WMBagNext(WMBag *bag, WMBagIterator *ptr);
 551
 552 void* WMBagPrevious(WMBag *bag, WMBagIterator *ptr);
 553
 554 void* WMBagIteratorAtIndex(WMBag *bag, int index, WMBagIterator *ptr);
 555
 556 int WMBagIndexForIterator(WMBag *bag, WMBagIterator ptr);
 557
 558
 559 /* The following 2 macros assume that the bag doesn't change in the for loop */
 560 #define WM_ITERATE_BAG(bag, var, i) \
 561         for (var = WMBagFirst(bag, &(i)); (i) != NULL; \
 562                 var = WMBagNext(bag, &(i)))
 563
 564 #define WM_ETARETI_BAG(bag, var, i) \
 565         for (var = WMBagLast(bag, &(i)); (i) != NULL; \
 566                 var = WMBagPrevious(bag, &(i)))
 567
 568
 569
 570 /*-------------------------------------------------------------------------*/
 571
 572 /* WMData handling */
 573
 574 /* Creating/destroying data */
 575
 576 WMData* WMCreateDataWithCapacity(unsigned capacity);
 577
 578 WMData* WMCreateDataWithLength(unsigned length);
 579
 580 WMData* WMCreateDataWithBytes(void *bytes, unsigned length);
 581
 582 /* destructor is a function called to free the data when releasing the data
 583  * object, or NULL if no freeing of data is necesary. */
 584 WMData* WMCreateDataWithBytesNoCopy(void *bytes, unsigned length,
 585                                     WMFreeDataProc *destructor);
 586
 587 WMData* WMCreateDataWithData(WMData *aData);
 588
 589 WMData* WMRetainData(WMData *aData);
 590
 591 void WMReleaseData(WMData *aData);
 592
 593 /* Adjusting capacity */
 594
 595 void WMSetDataCapacity(WMData *aData, unsigned capacity);
 596
 597 void WMSetDataLength(WMData *aData, unsigned length);
 598
 599 void WMIncreaseDataLengthBy(WMData *aData, unsigned extraLength);
 600
 601 /* Accessing data */
 602
 603 const void* WMDataBytes(WMData *aData);
 604
 605 void WMGetDataBytes(WMData *aData, void *buffer);
 606
 607 void WMGetDataBytesWithLength(WMData *aData, void *buffer, unsigned length);
 608
 609 void WMGetDataBytesWithRange(WMData *aData, void *buffer, WMRange aRange);
 610
 611 WMData* WMGetSubdataWithRange(WMData *aData, WMRange aRange);
 612
 613 /* Testing data */
 614
 615 Bool WMIsDataEqualToData(WMData *aData, WMData *anotherData);
 616
 617 unsigned WMGetDataLength(WMData *aData);
 618
 619 /* Adding data */
 620
 621 void WMAppendDataBytes(WMData *aData, void *bytes, unsigned length);
 622
 623 void WMAppendData(WMData *aData, WMData *anotherData);
 624
 625 /* Modifying data */
 626
 627 void WMReplaceDataBytesInRange(WMData *aData, WMRange aRange, void *bytes);
 628
 629 void WMResetDataBytesInRange(WMData *aData, WMRange aRange);
 630
 631 void WMSetData(WMData *aData, WMData *anotherData);
 632
 633
 634 void WMSetDataFormat(WMData *aData, unsigned format);
 635
 636 unsigned WMGetDataFormat(WMData *aData);
 637 /* Storing data */
 638
 639
 640 /*--------------------------------------------------------------------------*/
 641
 642 /* Generic Tree and TreeNode */
 643
 644 WMTreeNode* WMCreateTreeNode(void *data);
 645
 646 WMTreeNode* WMCreateTreeNodeWithDestructor(void *data, WMFreeDataProc *destructor);
 647
 648 WMTreeNode* WMInsertItemInTree(WMTreeNode *parent, int index, void *item);
 649
 650 #define WMAddItemToTree(parent, item)  WMInsertItemInTree(parent, -1, item)
 651
 652 WMTreeNode* WMInsertNodeInTree(WMTreeNode *parent, int index, WMTreeNode *aNode);
 653
 654 #define WMAddNodeToTree(parent, aNode)  WMInsertNodeInTree(parent, -1, aNode)
 655
 656 void WMDestroyTreeNode(WMTreeNode *aNode);
 657
 658 void WMDeleteLeafForTreeNode(WMTreeNode *aNode, int index);
 659
 660 void WMRemoveLeafForTreeNode(WMTreeNode *aNode, void *leaf);
 661
 662 void* WMReplaceDataForTreeNode(WMTreeNode *aNode, void *newData);
 663
 664 void* WMGetDataForTreeNode(WMTreeNode *aNode);
 665
 666 int WMGetTreeNodeDepth(WMTreeNode *aNode);
 667
 668 WMTreeNode* WMGetParentForTreeNode(WMTreeNode *aNode);
 669
 670 /* Sort only the leaves of the passed node */
 671 void WMSortLeavesForTreeNode(WMTreeNode *aNode, WMCompareDataProc *comparer);
 672
 673 /* Sort all tree recursively starting from the passed node */
 674 void WMSortTree(WMTreeNode *aNode, WMCompareDataProc *comparer);
 675
 676 /* Returns the first node which matches node's data with cdata by 'match' */
 677 WMTreeNode* WMFindInTree(WMTreeNode *aTree, WMMatchDataProc *match, void *cdata);
 678
 679 /* Returns first tree node that has data == cdata */
 680 #define WMGetFirstInTree(aTree, cdata) WMFindInTree(atree, NULL, cdata)
 681
 682
 683 /*--------------------------------------------------------------------------*/
 684
 685 /* Dictionaries */
 686 /*
 687 WMDictionary* WMCreateDictionaryFromElements(void *key, void *value, ...);
 688
 689 #define WMGetDictionaryEntryForKey(dict, key) WMHashGet(dict, key)
 690
 691 WMArray* WMGetAllDictionaryKeys(WMDictionary *dPtr);
 692 */
 693
 694 /*--------------------------------------------------------------------------*/
 695
 696
 697 WMNotification* WMCreateNotification(const char *name, void *object, void *clientData);
 698
 699 void WMReleaseNotification(WMNotification *notification);
 700
 701 WMNotification* WMRetainNotification(WMNotification *notification);
 702
 703 void* WMGetNotificationClientData(WMNotification *notification);
 704
 705 void* WMGetNotificationObject(WMNotification *notification);
 706
 707 const char* WMGetNotificationName(WMNotification *notification);
 708
 709
 710 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 711                                void *observer, const char *name, void *object);
 712
 713 void WMPostNotification(WMNotification *notification);
 714
 715 void WMRemoveNotificationObserver(void *observer);
 716
 717 void WMRemoveNotificationObserverWithName(void *observer, const char *name,
 718                                           void *object);
 719
 720 void WMPostNotificationName(const char *name, void *object, void *clientData);
 721
 722 WMNotificationQueue* WMGetDefaultNotificationQueue(void);
 723
 724 WMNotificationQueue* WMCreateNotificationQueue(void);
 725
 726 void WMDequeueNotificationMatching(WMNotificationQueue *queue,
 727                                    WMNotification *notification,
 728                                    unsigned mask);
 729
 730 void WMEnqueueNotification(WMNotificationQueue *queue,
 731                            WMNotification *notification,
 732                            WMPostingStyle postingStyle);
 733
 734 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 735                                    WMNotification *notification,
 736                                    WMPostingStyle postingStyle,
 737                                    unsigned coalesceMask);
 738
 739
 740 /*......................................................................*/
 741
 742 /* Property Lists handling */
 743
 744 void WMSetPropListStringComparer(WMCompareDataProc *comparer);
 745
 746 WMPropList* WMCreatePropListString(char *str);
 747
 748 WMPropList* WMCreatePropListDataWithBytes(unsigned char *bytes,
 749                                           unsigned int length);
 750 WMPropList* WMCreatePropListDataWithBytesNoCopy(unsigned char *bytes,
 751                                                 unsigned int length,
 752                                                 WMFreeDataProc *destructor);
 753
 754 WMPropList* WMCreatePropListDataWithData(WMData *data);
 755
 756 WMPropList* WMCreatePropListArrayFromElements(WMPropList *elem, ...);
 757
 758 WMPropList* WMCreatePropListDictionaryFromEntries(WMPropList *key,
 759                                                   WMPropList *value, ...);
 760
 761 WMPropList* WMRetainPropList(WMPropList *plist);
 762
 763 void WMReleasePropList(WMPropList *plist);
 764
 765 Bool WMPropListIsString(WMPropList *plist);
 766
 767 Bool WMPropListIsData(WMPropList *plist);
 768
 769 Bool WMPropListIsArray(WMPropList *plist);
 770
 771 Bool WMPropListIsDictionary(WMPropList *plist);
 772
 773 Bool WMPropListIsSimple(WMPropList *plist);
 774
 775 Bool WMPropListIsCompound(WMPropList *plist);
 776
 777 Bool WMArePropListsEqual(WMPropList *plist, WMPropList *other);
 778
 779
 780 /*......................................................................*/
 781
 782 WMUserDefaults* WMGetStandardUserDefaults(void);
 783
 784 WMUserDefaults* WMGetDefaultsFromPath(char *path);
 785
 786 void WMSynchronizeUserDefaults(WMUserDefaults *database);
 787
 788 void WMSaveUserDefaults(WMUserDefaults *database);
 789
 790 void WMEnableUDPeriodicSynchronization(WMUserDefaults *database, Bool enable);
 791
 792 /* Returns a PLArray with all keys in the user defaults database.
 793  * Free the returned array with PLRelease() when no longer needed,
 794  * but do not free the elements of the array! They're just references. */
 795 proplist_t WMGetUDAllKeys(WMUserDefaults *database);
 796
 797 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 798
 799 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 800                          char *defaultName);
 801
 802 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 803
 804 char* WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 805
 806 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 807
 808 float WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 809
 810 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 811
 812 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 813                          char *defaultName);
 814
 815 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 816                           char *defaultName);
 817
 818 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 819                         char *defaultName);
 820
 821 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 822                        char *defaultName);
 823
 824 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 825
 826 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 827
 828 extern char *WMUserDefaultsDidChangeNotification;
 829
 830
 831 /*-------------------------------------------------------------------------*/
 832
 833 /* WMHost: host handling */
 834
 835 WMHost* WMGetCurrentHost();
 836
 837 WMHost* WMGetHostWithName(char* name);
 838
 839 WMHost* WMGetHostWithAddress(char* address);
 840
 841 WMHost* WMRetainHost(WMHost *hPtr);
 842
 843 void WMReleaseHost(WMHost *hPtr);
 844
 845 /*
 846  * Host cache management
 847  * If enabled, only one object representing each host will be created, and
 848  * a shared instance will be returned by all methods that return a host.
 849  * Enabled by default.
 850  */
 851 void WMSetHostCacheEnabled(Bool flag);
 852
 853 Bool WMIsHostCacheEnabled();
 854
 855 void WMFlushHostCache();
 856
 857 /*
 858  * Compare hosts: Hosts are equal if they share at least one address
 859  */
 860 Bool WMIsHostEqualToHost(WMHost* hPtr, WMHost* anotherHost);
 861
 862 /*
 863  * Host names.
 864  * WMGetHostName() will return first name (official) if a host has several.
 865  * WMGetHostNames() will return a R/O WMArray with all the names of the host.
 866  */
 867 char* WMGetHostName(WMHost* hPtr);
 868
 869 /* The returned array is R/O. Do not modify it, and do not free it! */
 870 WMArray* WMGetHostNames(WMHost* hPtr);
 871
 872 /*
 873  * Host addresses.
 874  * Addresses are represented as "Dotted Decimal" strings, e.g. "192.42.172.1"
 875  * WMGetHostAddress() will return an arbitrary address if a host has several.
 876  * WMGetHostAddresses() will return a R/O WMArray with all addresses of the host.
 877  */
 878 char* WMGetHostAddress(WMHost* hPtr);
 879
 880 /* The returned array is R/O. Do not modify it, and do not free it! */
 881 WMArray* WMGetHostAddresses(WMHost* hPtr);
 882
 883
 884 /*-------------------------------------------------------------------------*/
 885
 886 /* WMConnection functions */
 887
 888 WMConnection* WMCreateConnectionAsServerAtAddress(char *host, char *service,
 889                                                   char *protocol);
 890
 891 WMConnection* WMCreateConnectionToAddress(char *host, char *service,
 892                                           char *protocol);
 893
 894 WMConnection* WMCreateConnectionToAddressAndNotify(char *host, char *service,
 895                                                    char *protocol);
 896
 897 void WMCloseConnection(WMConnection *cPtr);
 898
 899 void WMDestroyConnection(WMConnection *cPtr);
 900
 901 WMConnection* WMAcceptConnection(WMConnection *listener);
 902
 903 /* Release the returned data! */
 904 WMData* WMGetConnectionAvailableData(WMConnection *cPtr);
 905
 906 int WMSendConnectionData(WMConnection *cPtr, WMData *data);
 907
 908 Bool WMEnqueueConnectionData(WMConnection *cPtr, WMData *data);
 909
 910 #define WMFlushConnection(cPtr)  WMSendConnectionData((cPtr), NULL)
 911
 912 void WMSetConnectionDelegate(WMConnection *cPtr, ConnectionDelegate *delegate);
 913
 914 /* Connection info */
 915
 916 char* WMGetConnectionAddress(WMConnection *cPtr);
 917
 918 char* WMGetConnectionService(WMConnection *cPtr);
 919
 920 char* WMGetConnectionProtocol(WMConnection *cPtr);
 921
 922 Bool WMSetConnectionNonBlocking(WMConnection *cPtr, Bool flag);
 923
 924 Bool WMSetConnectionCloseOnExec(WMConnection *cPtr, Bool flag);
 925
 926 void* WMGetConnectionClientData(WMConnection *cPtr);
 927
 928 void WMSetConnectionClientData(WMConnection *cPtr, void *data);
 929
 930 unsigned int WMGetConnectionFlags(WMConnection *cPtr);
 931
 932 void WMSetConnectionFlags(WMConnection *cPtr, unsigned int flags);
 933
 934 int WMGetConnectionSocket(WMConnection *cPtr);
 935
 936 WMConnectionState WMGetConnectionState(WMConnection *cPtr);
 937
 938 WMConnectionTimeoutState WMGetConnectionTimeoutState(WMConnection *cPtr);
 939
 940 WMArray* WMGetConnectionUnsentData(WMConnection *cPtr);
 941
 942 #define WMGetConnectionQueuedData(cPtr) WMGetConnectionUnsentData(cPtr)
 943
 944
 945 /*
 946  * Passing timeout==0 in the SetTimeout functions below, will reset that
 947  * timeout to its default value.
 948  */
 949
 950 /* The default timeout inherited by all WMConnection operations, if none set */
 951 void WMSetConnectionDefaultTimeout(unsigned int timeout);
 952
 953 /* Global timeout for all WMConnection objects, for opening a new connection */
 954 void WMSetConnectionOpenTimeout(unsigned int timeout);
 955
 956 /* Connection specific timeout for sending out data */
 957 void WMSetConnectionSendTimeout(WMConnection *cPtr, unsigned int timeout);
 958
 959
 960 /* Global variables */
 961
 962 extern int WCErrorCode;
 963
 964
 965 /*-------------------------------------------------------------------------*/
 966
 967
 968
 969 #ifdef __cplusplus
 970 }
 971 #endif /* __cplusplus */
 972
 973
 974 #endif