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
 160 void *wmalloc(size_t size);
 161 void *wrealloc(void *ptr, size_t newsize);
 162
 163 void wrelease(void *ptr);
 164 void *wretain(void *ptr);
 165
 166 char *wstrdup(char *str);
 167
 168 char *wstrappend(char *dst, char *src);
 169
 170 char *wusergnusteppath();
 171
 172 char *wdefaultspathfordomain(char *domain);
 173
 174 void wusleep(unsigned int microsec);
 175
 176 #if 0
 177 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 178                int count);
 179 #endif
 180
 181 /*......................................................................*/
 182
 183 /* This function is used _only_ if you create a NON-GUI program.
 184  * For GUI based programs use WMNextEvent()/WMHandleEvent() instead.
 185  * This function will handle all input/timer/idle events, then return.
 186  */
 187
 188 void WHandleEvents();
 189
 190 /*......................................................................*/
 191
 192
 193 WMHashTable *WMCreateHashTable(WMHashTableCallbacks callbacks);
 194
 195 void WMFreeHashTable(WMHashTable *table);
 196
 197 void WMResetHashTable(WMHashTable *table);
 198
 199 void *WMHashGet(WMHashTable *table, const void *key);
 200
 201 /* put data in table, replacing already existing data and returning
 202  * the old value */
 203 void *WMHashInsert(WMHashTable *table, void *key, void *data);
 204
 205 void WMHashRemove(WMHashTable *table, const void *key);
 206
 207 /* warning: do not manipulate the table while using these functions */
 208 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 209
 210 void *WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 211
 212 unsigned WMCountHashTable(WMHashTable *table);
 213
 214
 215
 216
 217 /* some predefined callback sets */
 218
 219 extern const WMHashTableCallbacks WMIntHashCallbacks;
 220 /* sizeof(keys) are <= sizeof(void*) */
 221
 222 extern const WMHashTableCallbacks WMStringHashCallbacks;
 223 /* keys are strings. Strings will be copied with wstrdup()
 224  * and freed with free() */
 225
 226 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 227 /* keys are strings, bug they are not copied */
 228
 229
 230 /*......................................................................*/
 231
 232
 233 WMBag *WMCreateBag(int size);
 234
 235 int WMGetBagItemCount(WMBag *bag);
 236
 237 void WMAppendBag(WMBag *bag, WMBag *appendedBag);
 238
 239 void WMPutInBag(WMBag *bag, void *item);
 240
 241 void WMInsertInBag(WMBag *bag, int index, void *item);
 242
 243 int WMGetFirstInBag(WMBag *bag, void *item);
 244
 245 int WMGetLastInBag(WMBag *bag, void *item);
 246
 247 void WMRemoveFromBag(WMBag *bag, void *item);
 248
 249 void WMDeleteFromBag(WMBag *bag, int index);
 250
 251 void *WMGetFromBag(WMBag *bag, int index);
 252
 253 int WMCountInBag(WMBag *bag, void *item);
 254
 255
 256 /* comparer must return:
 257  * < 0 if a < b
 258  * > 0 if a > b
 259  * = 0 if a = b
 260  */
 261 void WMSortBag(WMBag *bag, int (*comparer)(void*,void*));
 262
 263 void WMEmptyBag(WMBag *bag);
 264
 265 void WMFreeBag(WMBag *bag);
 266
 267 WMBag *WMMapBag(WMBag *bag, void* (*function)(void*));
 268
 269 /*......................................................................*/
 270
 271 WMNotification *WMCreateNotification(char *name, void *object, void *clientData);
 272
 273 void WMReleaseNotification(WMNotification *notification);
 274
 275 WMNotification *WMRetainNotification(WMNotification *notification);
 276
 277 void *WMGetNotificationClientData(WMNotification *notification);
 278
 279 void *WMGetNotificationObject(WMNotification *notification);
 280
 281 char *WMGetNotificationName(WMNotification *notification);
 282
 283
 284 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 285                                void *observer, char *name, void *object);
 286
 287 void WMPostNotification(WMNotification *notification);
 288
 289 void WMRemoveNotificationObserver(void *observer);
 290
 291 void WMRemoveNotificationObserverWithName(void *observer, char *name,
 292                                           void *object);
 293
 294 void WMPostNotificationName(char *name, void *object, void *clientData);
 295
 296 WMNotificationQueue *WMGetDefaultNotificationQueue(void);
 297
 298 WMNotificationQueue *WMCreateNotificationQueue(void);
 299
 300 void WMDequeueNotificationMatching(WMNotificationQueue *queue,
 301                                    WMNotification *notification,
 302                                    unsigned mask);
 303
 304 void WMEnqueueNotification(WMNotificationQueue *queue,
 305                            WMNotification *notification,
 306                            WMPostingStyle postingStyle);
 307
 308 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 309                                    WMNotification *notification,
 310                                    WMPostingStyle postingStyle,
 311                                    unsigned coalesceMask);
 312
 313
 314 /*......................................................................*/
 315
 316 WMUserDefaults *WMGetStandardUserDefaults(void);
 317
 318 WMUserDefaults *WMGetDefaultsFromPath(char *path);
 319
 320 void WMSynchronizeUserDefaults(WMUserDefaults *database);
 321
 322 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 323
 324 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 325                          char *defaultName);
 326
 327 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 328
 329 /* you can free the returned string */
 330 char *WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 331
 332 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 333
 334 float WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 335
 336 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 337
 338 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 339                          char *defaultName);
 340
 341 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 342                           char *defaultName);
 343
 344 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 345                         char *defaultName);
 346
 347 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 348                        char *defaultName);
 349
 350 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 351
 352 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 353
 354 #ifdef __cplusplus
 355 }
 356 #endif /* __cplusplus */
 357
 358
 359 #endif