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 WMDictionary;
 125 typedef struct W_HashTable WMHashTable;
 126 typedef struct W_UserDefaults WMUserDefaults;
 127 typedef struct W_Notification WMNotification;
 128 typedef struct W_NotificationQueue WMNotificationQueue;
 129 typedef struct W_Host WMHost;
 130 typedef struct W_Connection WMConnection;
 131
 132
 133 typedef int WMCompareDataProc(const void *item1, const void *item2);
 134
 135 typedef void WMFreeDataProc(void *data);
 136
 137 /* Used by WMBag or WMArray for matching data */
 138 typedef int WMMatchDataProc(void *item, void *cdata);
 139
 140
 141
 142
 143 typedef struct {
 144     int position;
 145     int count;
 146 } WMRange;
 147
 148
 149
 150 /* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
 151 typedef struct {
 152     void *table;
 153     void *nextItem;
 154     int index;
 155 } WMHashEnumerator;
 156
 157
 158 typedef struct {
 159     /* NULL is pointer hash */
 160     unsigned    (*hash)(const void *);
 161     /* NULL is pointer compare */
 162     Bool        (*keyIsEqual)(const void *, const void *);
 163     /* NULL does nothing */
 164     void*       (*retainKey)(const void *);
 165     /* NULL does nothing */
 166     void        (*releaseKey)(const void *);
 167 } WMHashTableCallbacks;
 168
 169
 170 typedef void *WMBagIterator;
 171
 172
 173 #if 0
 174 typedef struct {
 175     char character;                    /* the escape character */
 176     char *value;                       /* value to place */
 177 } WMSEscapes;
 178 #endif
 179
 180
 181 /* The connection callbacks */
 182 typedef struct ConnectionDelegate {
 183     void *data;
 184
 185     void (*didCatchException)(struct ConnectionDelegate *self,
 186                               WMConnection *cPtr);
 187
 188     void (*didDie)(struct ConnectionDelegate *self, WMConnection *cPtr);
 189
 190     void (*didInitialize)(struct ConnectionDelegate *self, WMConnection *cPtr);
 191
 192     void (*didReceiveInput)(struct ConnectionDelegate *self, WMConnection *cPtr);
 193
 194     void (*didTimeout)(struct ConnectionDelegate *self, WMConnection *cPtr);
 195
 196 } ConnectionDelegate;
 197
 198
 199 typedef void WMNotificationObserverAction(void *observerData,
 200                                           WMNotification *notification);
 201
 202
 203
 204 /*......................................................................*/
 205
 206 typedef void (waborthandler)(int);
 207
 208 waborthandler* wsetabort(waborthandler*);
 209
 210
 211 /* don't free the returned string */
 212 char* wstrerror(int errnum);
 213
 214 void wmessage(const char *msg, ...);
 215 void wwarning(const char *msg, ...);
 216 void wfatal(const char *msg, ...);
 217 void wsyserror(const char *msg, ...);
 218 void wsyserrorwithcode(int error, const char *msg, ...);
 219
 220 char* wfindfile(char *paths, char *file);
 221
 222 char* wfindfileinlist(char **path_list, char *file);
 223
 224 char* wfindfileinarray(proplist_t array, char *file);
 225
 226 char* wexpandpath(char *path);
 227
 228 /* don't free the returned string */
 229 char* wgethomedir();
 230
 231 void* wmalloc(size_t size);
 232 void* wrealloc(void *ptr, size_t newsize);
 233 void wfree(void *ptr);
 234
 235
 236 void wrelease(void *ptr);
 237 void* wretain(void *ptr);
 238
 239 char* wstrdup(char *str);
 240
 241 /* Concatenate str1 with str2 and return that in a newly malloc'ed string.
 242  * str1 and str2 can be any strings including static and constant strings.
 243  * str1 and str2 will not be modified.
 244  * Free the returned string when you're done with it. */
 245 char* wstrconcat(char *str1, char *str2);
 246
 247 /* This will append src to dst, and return dst. dst MUST be either NULL
 248  * or a string that was a result of a dynamic allocation (malloc, realloc
 249  * wmalloc, wrealloc, ...). dst CANNOT be a static or a constant string!
 250  * Modifies dst (no new string is created except if dst==NULL in which case
 251  * it is equivalent to calling wstrdup(src) ).
 252  * The returned address may be different from the original address of dst,
 253  * so always assign the returned address to avoid dangling pointers. */
 254 char* wstrappend(char *dst, char *src);
 255
 256
 257 void wtokensplit(char *command, char ***argv, int *argc);
 258
 259 char* wtokennext(char *word, char **next);
 260
 261 char* wtokenjoin(char **list, int count);
 262
 263 void wtokenfree(char **tokens, int count);
 264
 265 char* wtrimspace(char *s);
 266
 267
 268
 269 char* wusergnusteppath();
 270
 271 char* wdefaultspathfordomain(char *domain);
 272
 273 void wusleep(unsigned int microsec);
 274
 275 #if 0
 276 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 277                int count);
 278 #endif
 279
 280 /*......................................................................*/
 281
 282 /* This function is used _only_ if you create a NON-GUI program.
 283  * For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
 284  * This function will handle all input/timer/idle events, then return.
 285  */
 286
 287 void WHandleEvents();
 288
 289 /*......................................................................*/
 290
 291
 292 WMHashTable* WMCreateHashTable(WMHashTableCallbacks callbacks);
 293
 294 void WMFreeHashTable(WMHashTable *table);
 295
 296 void WMResetHashTable(WMHashTable *table);
 297
 298 void* WMHashGet(WMHashTable *table, const void *key);
 299
 300 /* put data in table, replacing already existing data and returning
 301  * the old value */
 302 void* WMHashInsert(WMHashTable *table, const void *key, const void *data);
 303
 304 void WMHashRemove(WMHashTable *table, const void *key);
 305
 306 /* warning: do not manipulate the table while using these functions */
 307 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 308
 309 void* WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 310
 311 void* WMNextHashEnumeratorKey(WMHashEnumerator *enumerator);
 312
 313 unsigned WMCountHashTable(WMHashTable *table);
 314
 315
 316
 317
 318 /* some predefined callback sets */
 319
 320 extern const WMHashTableCallbacks WMIntHashCallbacks;
 321 /* sizeof(keys) are <= sizeof(void*) */
 322
 323 extern const WMHashTableCallbacks WMStringHashCallbacks;
 324 /* keys are strings. Strings will be copied with wstrdup()
 325  * and freed with wfree() */
 326
 327 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 328 /* keys are strings, bug they are not copied */
 329
 330
 331 /*......................................................................*/
 332
 333 /*
 334  * WMArray use an array to store the elements.
 335  * Item indexes may be only positive integer numbers.
 336  * The array cannot contain holes in it.
 337  *
 338  * Pros:
 339  * Fast [O(1)] access to elements
 340  * Fast [O(1)] push/pop
 341  *
 342  * Cons:
 343  * A little slower [O(n)] for insertion/deletion of elements that
 344  *      aren't in the end
 345  */
 346
 347 WMArray* WMCreateArray(int initialSize);
 348
 349 WMArray* WMCreateArrayWithDestructor(int initialSize, WMFreeDataProc *destructor);
 350
 351 WMArray* WMCreateArrayWithArray(WMArray *array);
 352
 353 #define WMDuplicateArray(array) WMCreateArrayWithArray(array)
 354
 355 void WMEmptyArray(WMArray *array);
 356
 357 void WMFreeArray(WMArray *array);
 358
 359 int WMGetArrayItemCount(WMArray *array);
 360
 361 /* appends other to array. other remains unchanged */
 362 void WMAppendArray(WMArray *array, WMArray *other);
 363
 364 /* add will place the element at the end of the array */
 365 void WMAddToArray(WMArray *array, void *item);
 366
 367 #define WMPushInArray(array, item) WMAddToArray(array, item)
 368
 369 /* insert will increment the index of elements after it by 1 */
 370 void WMInsertInArray(WMArray *array, int index, void *item);
 371
 372 /* replace and set will return the old item WITHOUT calling the
 373  * destructor on it even if its available. Free the returned item yourself.
 374  */
 375 void* WMReplaceInArray(WMArray *array, int index, void *item);
 376
 377 #define WMSetInArray(array, index, item) WMReplaceInArray(array, index, item)
 378
 379 /* delete and remove will remove the elements and cause the elements
 380  * after them to decrement their indexes by 1. Also will call the
 381  * destructor on the deleted element if there's one available.
 382  */
 383 int WMDeleteFromArray(WMArray *array, int index);
 384
 385 int WMRemoveFromArray(WMArray *array, void *item);
 386
 387 void* WMGetFromArray(WMArray *array, int index);
 388
 389 #define WMGetFirstInArray(array, item) WMFindInArray(array, NULL, item)
 390
 391 /* pop will return the last element from the array, also removing it
 392  * from the array. The destructor is NOT called, even if available.
 393  * Free the returned element if needed by yourself
 394  */
 395 void* WMPopFromArray(WMArray *array);
 396
 397 int WMFindInArray(WMArray *array, WMMatchDataProc *match, void *cdata);
 398
 399 int WMCountInArray(WMArray *array, void *item);
 400
 401 /* comparer must return:
 402  * < 0 if a < b
 403  * > 0 if a > b
 404  * = 0 if a = b
 405  */
 406 void WMSortArray(WMArray *array, WMCompareDataProc *comparer);
 407
 408 void WMMapArray(WMArray *array, void (*function)(void*, void*), void *data);
 409
 410 WMArray* WMGetSubarrayWithRange(WMArray* array, WMRange aRange);
 411
 412
 413 /*..........................................................................*/
 414
 415 /*
 416  * Tree bags use a red-black tree for storage.
 417  * Item indexes may be any integer number.
 418  *
 419  * Pros:
 420  * O(lg n) insertion/deletion/search
 421  * Good for large numbers of elements with sparse indexes
 422  *
 423  * Cons:
 424  * O(lg n) insertion/deletion/search
 425  * Slow for storing small numbers of elements
 426  */
 427
 428 #define WMCreateBag(size) WMCreateTreeBag()
 429
 430 #define WMCreateBagWithDestructor(size, d) WMCreateTreeBagWithDestructor(d)
 431
 432 WMBag* WMCreateTreeBag(void);
 433
 434 WMBag* WMCreateTreeBagWithDestructor(WMFreeDataProc *destructor);
 435
 436 int WMGetBagItemCount(WMBag *bag);
 437
 438 void WMAppendBag(WMBag *bag, WMBag *other);
 439
 440 void WMPutInBag(WMBag *bag, void *item);
 441
 442 /* insert will increment the index of elements after it by 1 */
 443 void WMInsertInBag(WMBag *bag, int index, void *item);
 444
 445 /* this is slow */
 446 /* erase will remove the element from the bag,
 447  * but will keep the index of the other elements unchanged */
 448 int WMEraseFromBag(WMBag *bag, int index);
 449
 450 /* delete and remove will remove the elements and cause the elements
 451  * after them to decrement their indexes by 1 */
 452 int WMDeleteFromBag(WMBag *bag, int index);
 453
 454 int WMRemoveFromBag(WMBag *bag, void *item);
 455
 456 void* WMGetFromBag(WMBag *bag, int index);
 457
 458 void* WMReplaceInBag(WMBag *bag, int index, void *item);
 459
 460 #define WMSetInBag(bag, index, item) WMReplaceInBag(bag, index, item)
 461
 462 /* comparer must return:
 463  * < 0 if a < b
 464  * > 0 if a > b
 465  * = 0 if a = b
 466  */
 467 void WMSortBag(WMBag *bag, WMCompareDataProc *comparer);
 468
 469 void WMEmptyBag(WMBag *bag);
 470
 471 void WMFreeBag(WMBag *bag);
 472
 473 void WMMapBag(WMBag *bag, void (*function)(void*, void*), void *data);
 474
 475 int WMGetFirstInBag(WMBag *bag, void *item);
 476
 477 int WMCountInBag(WMBag *bag, void *item);
 478
 479 int WMFindInBag(WMBag *bag, WMMatchDataProc *match, void *cdata);
 480
 481 void* WMBagFirst(WMBag *bag, WMBagIterator *ptr);
 482
 483 void* WMBagLast(WMBag *bag, WMBagIterator *ptr);
 484
 485 void* WMBagNext(WMBag *bag, WMBagIterator *ptr);
 486
 487 void* WMBagPrevious(WMBag *bag, WMBagIterator *ptr);
 488
 489 void* WMBagIteratorAtIndex(WMBag *bag, int index, WMBagIterator *ptr);
 490
 491 int WMBagIndexForIterator(WMBag *bag, WMBagIterator ptr);
 492
 493
 494 #define WM_ITERATE_BAG(bag, var, i) \
 495         for (var = WMBagFirst(bag, &(i)); (i) != NULL; \
 496                 var = WMBagNext(bag, &(i)))
 497
 498 #define WM_ETARETI_BAG(bag, var, i) \
 499         for (var = WMBagLast(bag, &(i)); (i) != NULL; \
 500                 var = WMBagPrevious(bag, &(i)))
 501
 502
 503
 504 /*-------------------------------------------------------------------------*/
 505
 506 /* WMData handling */
 507
 508 /* Creating/destroying data */
 509
 510 WMData* WMCreateDataWithCapacity(unsigned capacity);
 511
 512 WMData* WMCreateDataWithLength(unsigned length);
 513
 514 WMData* WMCreateDataWithBytes(void *bytes, unsigned length);
 515
 516 /* destructor is a function called to free the data when releasing the data
 517  * object, or NULL if no freeing of data is necesary. */
 518 WMData* WMCreateDataWithBytesNoCopy(void *bytes, unsigned length,
 519                                     WMFreeDataProc *destructor);
 520
 521 WMData* WMCreateDataWithData(WMData *aData);
 522
 523 WMData* WMRetainData(WMData *aData);
 524
 525 void WMReleaseData(WMData *aData);
 526
 527 /* Adjusting capacity */
 528
 529 void WMSetDataCapacity(WMData *aData, unsigned capacity);
 530
 531 void WMSetDataLength(WMData *aData, unsigned length);
 532
 533 void WMIncreaseDataLengthBy(WMData *aData, unsigned extraLength);
 534
 535 /* Accessing data */
 536
 537 const void* WMDataBytes(WMData *aData);
 538
 539 void WMGetDataBytes(WMData *aData, void *buffer);
 540
 541 void WMGetDataBytesWithLength(WMData *aData, void *buffer, unsigned length);
 542
 543 void WMGetDataBytesWithRange(WMData *aData, void *buffer, WMRange aRange);
 544
 545 WMData* WMGetSubdataWithRange(WMData *aData, WMRange aRange);
 546
 547 /* Testing data */
 548
 549 Bool WMIsDataEqualToData(WMData *aData, WMData *anotherData);
 550
 551 unsigned WMGetDataLength(WMData *aData);
 552
 553 /* Adding data */
 554
 555 void WMAppendDataBytes(WMData *aData, void *bytes, unsigned length);
 556
 557 void WMAppendData(WMData *aData, WMData *anotherData);
 558
 559 /* Modifying data */
 560
 561 void WMReplaceDataBytesInRange(WMData *aData, WMRange aRange, void *bytes);
 562
 563 void WMResetDataBytesInRange(WMData *aData, WMRange aRange);
 564
 565 void WMSetData(WMData *aData, WMData *anotherData);
 566
 567
 568 void WMSetDataFormat(WMData *aData, unsigned format);
 569
 570 unsigned WMGetDataFormat(WMData *aData);
 571 /* Storing data */
 572
 573
 574 /*--------------------------------------------------------------------------*/
 575
 576 /* Generic Tree and TreeNode */
 577
 578 WMTreeNode* WMCreateTreeNode(void *data);
 579
 580 WMTreeNode* WMCreateTreeNodeWithDestructor(void *data, WMFreeDataProc *destructor);
 581
 582 WMTreeNode* WMInsertItemInTree(WMTreeNode *parent, int index, void *item);
 583
 584 #define WMAddItemToTree(parent, item)  WMInsertItemInTree(parent, -1, item)
 585
 586 WMTreeNode* WMInsertNodeInTree(WMTreeNode *parent, int index, WMTreeNode *aNode);
 587
 588 #define WMAddNodeToTree(parent, aNode)  WMInsertNodeInTree(parent, -1, aNode)
 589
 590 void WMDestroyTreeNode(WMTreeNode *aNode);
 591
 592 void WMDeleteLeafForTreeNode(WMTreeNode *aNode, int index);
 593
 594 void WMRemoveLeafForTreeNode(WMTreeNode *aNode, void *leaf);
 595
 596 void* WMReplaceDataForTreeNode(WMTreeNode *aNode, void *newData);
 597
 598 void* WMGetDataForTreeNode(WMTreeNode *aNode);
 599
 600 int WMGetTreeNodeDepth(WMTreeNode *aNode);
 601
 602 WMTreeNode* WMGetParentForTreeNode(WMTreeNode *aNode);
 603
 604 /* Sort only the leaves of the passed node */
 605 void WMSortLeavesForTreeNode(WMTreeNode *aNode, WMCompareDataProc *comparer);
 606
 607 /* Sort all tree recursively starting from the passed node */
 608 void WMSortTree(WMTreeNode *aNode, WMCompareDataProc *comparer);
 609
 610 /* Returns the first node which matches node's data with cdata by 'match' */
 611 WMTreeNode* WMFindInTree(WMTreeNode *aTree, WMMatchDataProc *match, void *cdata);
 612
 613 /* Returns first tree node that has data == cdata */
 614 #define WMGetFirstInTree(aTree, cdata) WMFindInTree(atree, NULL, cdata)
 615
 616
 617 /*--------------------------------------------------------------------------*/
 618
 619 /* Dictionaries */
 620 /*
 621 WMDictionary* WMCreateDictionaryFromElements(void *key, void *value, ...);
 622
 623 #define WMGetDictionaryEntryForKey(dict, key) WMHashGet(dict, key)
 624
 625 WMArray* WMGetAllDictionaryKeys(WMDictionary *dPtr);
 626 */
 627
 628 /*--------------------------------------------------------------------------*/
 629
 630
 631 WMNotification* WMCreateNotification(const char *name, void *object, void *clientData);
 632
 633 void WMReleaseNotification(WMNotification *notification);
 634
 635 WMNotification* WMRetainNotification(WMNotification *notification);
 636
 637 void* WMGetNotificationClientData(WMNotification *notification);
 638
 639 void* WMGetNotificationObject(WMNotification *notification);
 640
 641 const char* WMGetNotificationName(WMNotification *notification);
 642
 643
 644 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 645                                void *observer, const char *name, void *object);
 646
 647 void WMPostNotification(WMNotification *notification);
 648
 649 void WMRemoveNotificationObserver(void *observer);
 650
 651 void WMRemoveNotificationObserverWithName(void *observer, const char *name,
 652                                           void *object);
 653
 654 void WMPostNotificationName(const char *name, void *object, void *clientData);
 655
 656 WMNotificationQueue* WMGetDefaultNotificationQueue(void);
 657
 658 WMNotificationQueue* WMCreateNotificationQueue(void);
 659
 660 void WMDequeueNotificationMatching(WMNotificationQueue *queue,
 661                                    WMNotification *notification,
 662                                    unsigned mask);
 663
 664 void WMEnqueueNotification(WMNotificationQueue *queue,
 665                            WMNotification *notification,
 666                            WMPostingStyle postingStyle);
 667
 668 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 669                                    WMNotification *notification,
 670                                    WMPostingStyle postingStyle,
 671                                    unsigned coalesceMask);
 672
 673
 674 /*......................................................................*/
 675
 676 WMUserDefaults* WMGetStandardUserDefaults(void);
 677
 678 WMUserDefaults* WMGetDefaultsFromPath(char *path);
 679
 680 void WMSynchronizeUserDefaults(WMUserDefaults *database);
 681
 682 void WMSaveUserDefaults(WMUserDefaults *database);
 683
 684 void WMEnableUDPeriodicSynchronization(WMUserDefaults *database, Bool enable);
 685
 686 /* Returns a PLArray with all keys in the user defaults database.
 687  * Free the returned array with PLRelease() when no longer needed,
 688  * but do not free the elements of the array! They're just references. */
 689 proplist_t WMGetUDAllKeys(WMUserDefaults *database);
 690
 691 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 692
 693 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 694                          char *defaultName);
 695
 696 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 697
 698 char* WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 699
 700 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 701
 702 float WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 703
 704 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 705
 706 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 707                          char *defaultName);
 708
 709 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 710                           char *defaultName);
 711
 712 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 713                         char *defaultName);
 714
 715 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 716                        char *defaultName);
 717
 718 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 719
 720 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 721
 722 extern char *WMUserDefaultsDidChangeNotification;
 723
 724
 725 /*-------------------------------------------------------------------------*/
 726
 727 /* WMHost: host handling */
 728
 729 WMHost* WMGetCurrentHost();
 730
 731 WMHost* WMGetHostWithName(char* name);
 732
 733 WMHost* WMGetHostWithAddress(char* address);
 734
 735 WMHost* WMRetainHost(WMHost *hPtr);
 736
 737 void WMReleaseHost(WMHost *hPtr);
 738
 739 /*
 740  * Host cache management
 741  * If enabled, only one object representing each host will be created, and
 742  * a shared instance will be returned by all methods that return a host.
 743  * Enabled by default.
 744  */
 745 void WMSetHostCacheEnabled(Bool flag);
 746
 747 Bool WMIsHostCacheEnabled();
 748
 749 void WMFlushHostCache();
 750
 751 /*
 752  * Compare hosts: Hosts are equal if they share at least one address
 753  */
 754 Bool WMIsHostEqualToHost(WMHost* hPtr, WMHost* anotherHost);
 755
 756 /*
 757  * Host names.
 758  * WMGetHostName() will return first name (official) if a host has several.
 759  * WMGetHostNames() will return a R/O WMArray with all the names of the host.
 760  */
 761 char* WMGetHostName(WMHost* hPtr);
 762
 763 /* The returned array is R/O. Do not modify it, and do not free it! */
 764 WMArray* WMGetHostNames(WMHost* hPtr);
 765
 766 /*
 767  * Host addresses.
 768  * Addresses are represented as "Dotted Decimal" strings, e.g. "192.42.172.1"
 769  * WMGetHostAddress() will return an arbitrary address if a host has several.
 770  * WMGetHostAddresses() will return a R/O WMArray with all addresses of the host.
 771  */
 772 char* WMGetHostAddress(WMHost* hPtr);
 773
 774 /* The returned array is R/O. Do not modify it, and do not free it! */
 775 WMArray* WMGetHostAddresses(WMHost* hPtr);
 776
 777
 778 /*-------------------------------------------------------------------------*/
 779
 780 /* WMConnection functions */
 781
 782 WMConnection* WMCreateConnectionAsServerAtAddress(char *host, char *service,
 783                                                   char *protocol);
 784
 785 WMConnection* WMCreateConnectionToAddress(char *host, char *service,
 786                                           char *protocol);
 787
 788 WMConnection* WMCreateConnectionToAddressAndNotify(char *host, char *service,
 789                                                    char *protocol);
 790
 791 void WMCloseConnection(WMConnection *cPtr);
 792
 793 void WMDestroyConnection(WMConnection *cPtr);
 794
 795 WMConnection* WMAcceptConnection(WMConnection *listener);
 796
 797 /* Release the returned data! */
 798 WMData* WMGetConnectionAvailableData(WMConnection *cPtr);
 799
 800 int WMSendConnectionData(WMConnection *cPtr, WMData *data);
 801
 802 Bool WMEnqueueConnectionData(WMConnection *cPtr, WMData *data);
 803
 804 #define WMFlushConnection(cPtr)  WMSendConnectionData((cPtr), NULL)
 805
 806 void WMSetConnectionDelegate(WMConnection *cPtr, ConnectionDelegate *delegate);
 807
 808 /* Connection info */
 809
 810 char* WMGetConnectionAddress(WMConnection *cPtr);
 811
 812 char* WMGetConnectionService(WMConnection *cPtr);
 813
 814 char* WMGetConnectionProtocol(WMConnection *cPtr);
 815
 816 Bool WMSetConnectionNonBlocking(WMConnection *cPtr, Bool flag);
 817
 818 Bool WMSetConnectionCloseOnExec(WMConnection *cPtr, Bool flag);
 819
 820 void* WMGetConnectionClientData(WMConnection *cPtr);
 821
 822 void WMSetConnectionClientData(WMConnection *cPtr, void *data);
 823
 824 unsigned int WMGetConnectionFlags(WMConnection *cPtr);
 825
 826 void WMSetConnectionFlags(WMConnection *cPtr, unsigned int flags);
 827
 828 int WMGetConnectionSocket(WMConnection *cPtr);
 829
 830 WMConnectionState WMGetConnectionState(WMConnection *cPtr);
 831
 832 WMConnectionTimeoutState WMGetConnectionTimeoutState(WMConnection *cPtr);
 833
 834 WMArray* WMGetConnectionUnsentData(WMConnection *cPtr);
 835
 836 #define WMGetConnectionQueuedData(cPtr) WMGetConnectionUnsentData(cPtr)
 837
 838
 839 /*
 840  * Passing timeout==0 in the SetTimeout functions below, will reset that
 841  * timeout to its default value.
 842  */
 843
 844 /* The default timeout inherited by all WMConnection operations, if none set */
 845 void WMSetConnectionDefaultTimeout(unsigned int timeout);
 846
 847 /* Global timeout for all WMConnection objects, for opening a new connection */
 848 void WMSetConnectionOpenTimeout(unsigned int timeout);
 849
 850 /* Connection specific timeout for sending out data */
 851 void WMSetConnectionSendTimeout(WMConnection *cPtr, unsigned int timeout);
 852
 853
 854 /* Global variables */
 855
 856 extern int WCErrorCode;
 857
 858
 859 /*-------------------------------------------------------------------------*/
 860
 861
 862
 863 #ifdef __cplusplus
 864 }
 865 #endif /* __cplusplus */
 866
 867
 868 #endif