WINGs/WUtil.h

   1 #ifndef _WUTIL_H_
   2 #define _WUTIL_H_
   3
   4 #include <X11/Xlib.h>
   5
   6 #include <sys/types.h>
   7
   8
   9 /* SunOS 4.x Blargh.... */
  10 #ifndef NULL
  11 #define NULL ((void*)0)
  12 #endif
  13
  14
  15 /*
  16  * Warning: proplist.h #defines BOOL which will clash with the
  17  * typedef BOOL in Xmd.h
  18  * proplist.h should use Bool (which is a #define in Xlib.h) instead.
  19  *
  20  */
  21 #include <proplist.h>
  22
  23
  24 #ifndef WMAX
  25 # define WMAX(a,b)      ((a)>(b) ? (a) : (b))
  26 #endif
  27 #ifndef WMIN
  28 # define WMIN(a,b)      ((a)<(b) ? (a) : (b))
  29 #endif
  30
  31
  32 #if (!defined (__GNUC__) || __GNUC__ < 2 || \
  33      __GNUC_MINOR__ < (defined (__cplusplus) ? 6 : 4))
  34 #define __ASSERT_FUNCTION       ((char *) 0)
  35 #else
  36 #define __ASSERT_FUNCTION       __PRETTY_FUNCTION__
  37 #endif
  38
  39
  40 #ifdef NDEBUG
  41
  42 #define wassertr(expr)          {}
  43 #define wassertrv(expr, val)    {}
  44
  45 #else /* !NDEBUG */
  46
  47 #ifdef DEBUG
  48
  49 #include <assert.h>
  50
  51 #define wassertr(expr)  assert(expr)
  52
  53 #define wassertrv(expr, val)    assert(expr)
  54
  55 #else /* !DEBUG */
  56
  57 #define wassertr(expr) \
  58         if (!(expr)) { \
  59                 wwarning("%s line %i (%s): assertion %s failed",\
  60                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  61                 return;\
  62         }
  63
  64 #define wassertrv(expr, val) \
  65         if (!(expr)) { \
  66                 wwarning("%s line %i (%s): assertion %s failed",\
  67                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  68                 return (val);\
  69         }
  70 #endif /* !DEBUG */
  71
  72 #endif /* !NDEBUG */
  73
  74
  75 #ifdef __cplusplus
  76 extern "C" {
  77 #endif /* __cplusplus */
  78
  79
  80 typedef enum {
  81     WMPostWhenIdle = 1,
  82         WMPostASAP = 2,
  83         WMPostNow = 3
  84 } WMPostingStyle;
  85
  86
  87 typedef enum {
  88     WNCNone = 0,
  89         WNCOnName = 1,
  90         WNCOnSender = 2
  91 } WMNotificationCoalescing;
  92
  93
  94
  95 typedef struct W_Bag WMBag; /* equivalent to a linked list or array */
  96 typedef struct W_HashTable WMHashTable;
  97 typedef struct W_UserDefaults WMUserDefaults;
  98 typedef struct W_Notification WMNotification;
  99 typedef struct W_NotificationQueue WMNotificationQueue;
 100
 101
 102
 103 /* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
 104 typedef struct {
 105     void *table;
 106     void *nextItem;
 107     int index;
 108 } WMHashEnumerator;
 109
 110
 111 typedef struct {
 112     /* NULL is pointer hash */
 113     unsigned    (*hash)(const void *);
 114     /* NULL is pointer compare */
 115     Bool        (*keyIsEqual)(const void *, const void *);
 116     /* NULL does nothing */
 117     void*       (*retainKey)(const void *);
 118     /* NULL does nothing */
 119     void        (*releaseKey)(const void *);
 120 } WMHashTableCallbacks;
 121
 122
 123
 124 #if 0
 125 typedef struct {
 126     char character;                    /* the escape character */
 127     char *value;                       /* value to place */
 128 } WMSEscapes;
 129 #endif
 130
 131
 132
 133 typedef void WMNotificationObserverAction(void *observerData,
 134                                           WMNotification *notification);
 135
 136
 137
 138 /*......................................................................*/
 139
 140 typedef void (waborthandler)(int);
 141
 142 waborthandler *wsetabort(waborthandler*);
 143
 144
 145 void wfatal(const char *msg, ...);
 146 void wwarning(const char *msg, ...);
 147 void wsyserror(const char *msg, ...);
 148
 149 char *wfindfile(char *paths, char *file);
 150
 151 char *wfindfileinlist(char **path_list, char *file);
 152
 153 char *wfindfileinarray(proplist_t array, char *file);
 154
 155 char *wexpandpath(char *path);
 156
 157 /* don't free the returned string */
 158 char *wgethomedir();
 159 void *wmalloc(size_t size);
 160 void *wrealloc(void *ptr, size_t newsize);
 161 void wfree(void *ptr);
 162
 163
 164 void wrelease(void *ptr);
 165 void *wretain(void *ptr);
 166
 167 char *wstrdup(char *str);
 168
 169 char *wstrappend(char *dst, char *src);
 170
 171 char *wusergnusteppath();
 172
 173 char *wdefaultspathfordomain(char *domain);
 174
 175 void wusleep(unsigned int microsec);
 176
 177 #if 0
 178 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 179                int count);
 180 #endif
 181
 182 /*......................................................................*/
 183
 184 /* This function is used _only_ if you create a NON-GUI program.
 185  * For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
 186  * This function will handle all input/timer/idle events, then return.
 187  */
 188
 189 void WHandleEvents();
 190
 191 /*......................................................................*/
 192
 193
 194 WMHashTable *WMCreateHashTable(WMHashTableCallbacks callbacks);
 195
 196 void WMFreeHashTable(WMHashTable *table);
 197
 198 void WMResetHashTable(WMHashTable *table);
 199
 200 void *WMHashGet(WMHashTable *table, const void *key);
 201
 202 /* put data in table, replacing already existing data and returning
 203  * the old value */
 204 void *WMHashInsert(WMHashTable *table, void *key, void *data);
 205
 206 void WMHashRemove(WMHashTable *table, const void *key);
 207
 208 /* warning: do not manipulate the table while using these functions */
 209 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 210
 211 void *WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 212
 213 unsigned WMCountHashTable(WMHashTable *table);
 214
 215
 216
 217
 218 /* some predefined callback sets */
 219
 220 extern const WMHashTableCallbacks WMIntHashCallbacks;
 221 /* sizeof(keys) are <= sizeof(void*) */
 222
 223 extern const WMHashTableCallbacks WMStringHashCallbacks;
 224 /* keys are strings. Strings will be copied with wstrdup()
 225  * and freed with free() */
 226
 227 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 228 /* keys are strings, bug they are not copied */
 229
 230
 231 /*......................................................................*/
 232
 233
 234 WMBag *WMCreateBag(int size);
 235
 236 int WMGetBagItemCount(WMBag *bag);
 237
 238 void WMAppendBag(WMBag *bag, WMBag *appendedBag);
 239
 240 void WMPutInBag(WMBag *bag, void *item);
 241
 242 void WMInsertInBag(WMBag *bag, int index, void *item);
 243
 244 int WMGetFirstInBag(WMBag *bag, void *item);
 245
 246 int WMGetLastInBag(WMBag *bag, void *item);
 247
 248 void WMRemoveFromBag(WMBag *bag, void *item);
 249
 250 void WMDeleteFromBag(WMBag *bag, int index);
 251
 252 void *WMGetFromBag(WMBag *bag, int index);
 253
 254 int WMCountInBag(WMBag *bag, void *item);
 255
 256
 257 /* comparer must return:
 258  * < 0 if a < b
 259  * > 0 if a > b
 260  * = 0 if a = b
 261  */
 262 void WMSortBag(WMBag *bag, int (*comparer)(const void*, const void*));
 263
 264 void WMEmptyBag(WMBag *bag);
 265
 266 void WMFreeBag(WMBag *bag);
 267
 268 WMBag *WMMapBag(WMBag *bag, void* (*function)(void*));
 269
 270 /*......................................................................*/
 271
 272 WMNotification *WMCreateNotification(char *name, void *object, void *clientData);
 273
 274 void WMReleaseNotification(WMNotification *notification);
 275
 276 WMNotification *WMRetainNotification(WMNotification *notification);
 277
 278 void *WMGetNotificationClientData(WMNotification *notification);
 279
 280 void *WMGetNotificationObject(WMNotification *notification);
 281
 282 char *WMGetNotificationName(WMNotification *notification);
 283
 284
 285 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 286                                void *observer, char *name, void *object);
 287
 288 void WMPostNotification(WMNotification *notification);
 289
 290 void WMRemoveNotificationObserver(void *observer);
 291
 292 void WMRemoveNotificationObserverWithName(void *observer, char *name,
 293                                           void *object);
 294
 295 void WMPostNotificationName(char *name, void *object, void *clientData);
 296
 297 WMNotificationQueue *WMGetDefaultNotificationQueue(void);
 298
 299 WMNotificationQueue *WMCreateNotificationQueue(void);
 300
 301 void WMDequeueNotificationMatching(WMNotificationQueue *queue,
 302                                    WMNotification *notification,
 303                                    unsigned mask);
 304
 305 void WMEnqueueNotification(WMNotificationQueue *queue,
 306                            WMNotification *notification,
 307                            WMPostingStyle postingStyle);
 308
 309 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 310                                    WMNotification *notification,
 311                                    WMPostingStyle postingStyle,
 312                                    unsigned coalesceMask);
 313
 314
 315 /*......................................................................*/
 316
 317 WMUserDefaults *WMGetStandardUserDefaults(void);
 318
 319 WMUserDefaults *WMGetDefaultsFromPath(char *path);
 320
 321 void WMSynchronizeUserDefaults(WMUserDefaults *database);
 322
 323 void WMSaveUserDefaults(WMUserDefaults *database);
 324
 325 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 326
 327 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 328                          char *defaultName);
 329
 330 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 331
 332 /* you can free the returned string */
 333 char *WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 334
 335 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 336
 337 float WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 338
 339 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 340
 341 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 342                          char *defaultName);
 343
 344 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 345                           char *defaultName);
 346
 347 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 348                         char *defaultName);
 349
 350 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 351                        char *defaultName);
 352
 353 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 354
 355 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 356
 357 #ifdef __cplusplus
 358 }
 359 #endif /* __cplusplus */
 360
 361
 362 #endif