WINGs/WINGs/WUtil.h

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