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