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