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       ((__const char *) 0)
  35 #else
  36 #define __ASSERT_FUNCTION       __PRETTY_FUNCTION__
  37 #endif
  38
  39
  40 #ifdef NDEBUG
  41
  42 #define wassertr(expr, val)             ((void)0)
  43
  44 #else /* !NDEBUG */
  45
  46 #define wassertr(expr) \
  47         if (!(expr)) { \
  48                 wwarning("%s line %i (%s): assertion %s failed",\
  49                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  50                 return;\
  51         }
  52
  53 #define wassertrv(expr, val) \
  54         if (!(expr)) { \
  55                 wwarning("%s line %i (%s): assertion %s failed",\
  56                         __FILE__, __LINE__, __ASSERT_FUNCTION, #expr);\
  57                 return (val);\
  58         }
  59
  60 #endif /* !NDEBUG */
  61
  62
  63
  64 typedef enum {
  65     WMPostWhenIdle = 1,
  66         WMPostASAP = 2,
  67         WMPostNow = 3
  68 } WMPostingStyle;
  69
  70
  71 typedef enum {
  72     WNCNone = 0,
  73         WNCOnName = 1,
  74         WNCOnSender = 2
  75 } WMNotificationCoalescing;
  76
  77
  78
  79
  80 typedef struct W_HashTable WMHashTable;
  81 typedef struct W_UserDefaults WMUserDefaults;
  82 typedef struct W_Notification WMNotification;
  83 typedef struct W_NotificationQueue WMNotificationQueue;
  84
  85
  86 /* DO NOT ACCESS THE CONTENTS OF THIS STRUCT */
  87 typedef struct {
  88     void *table;
  89     void *nextItem;
  90     int index;
  91 } WMHashEnumerator;
  92
  93
  94 typedef struct {
  95     /* NULL is pointer hash */
  96     unsigned    (*hash)(const void *);
  97     /* NULL is pointer compare */
  98     Bool        (*keyIsEqual)(const void *, const void *);
  99     /* NULL does nothing */
 100     void*       (*retainKey)(const void *);
 101     /* NULL does nothing */
 102     void        (*releaseKey)(const void *);
 103 } WMHashTableCallbacks;
 104
 105
 106 #if 0
 107 typedef struct {
 108     char character;                    /* the escape character */
 109     char *value;                       /* value to place */
 110 } WMSEscapes;
 111 #endif
 112
 113
 114 typedef void WMNotificationObserverAction(void *observerData,
 115                                           WMNotification *notification);
 116
 117
 118
 119 /*......................................................................*/
 120
 121
 122 void wfatal(const char *msg, ...);
 123 void wwarning(const char *msg, ...);
 124 void wsyserror(const char *msg, ...);
 125
 126 char *wfindfile(char *paths, char *file);
 127
 128 char *wfindfileinlist(char **path_list, char *file);
 129
 130 char *wexpandpath(char *path);
 131
 132 /* don't free the returned string */
 133 char *wgethomedir();
 134
 135 void *wmalloc(size_t size);
 136 void *wrealloc(void *ptr, size_t newsize);
 137
 138 void wrelease(void *ptr);
 139 void *wretain(void *ptr);
 140
 141 char *wstrdup(char *str);
 142
 143 char *wstrappend(char *dst, char *src);
 144
 145 char *wusergnusteppath();
 146
 147 char *wdefaultspathfordomain(char *domain);
 148
 149 void wusleep(unsigned int microsec);
 150
 151 #if 0
 152 int wsprintesc(char *buffer, int length, char *format, WMSEscapes **escapes,
 153                int count);
 154 #endif
 155 /*......................................................................*/
 156
 157
 158 WMHashTable *WMCreateHashTable(WMHashTableCallbacks callbacks);
 159
 160 void WMFreeHashTable(WMHashTable *table);
 161
 162 void WMResetHashTable(WMHashTable *table);
 163
 164 void *WMHashGet(WMHashTable *table, const void *key);
 165
 166 /* put data in table, replacing already existing data and returning
 167  * the old value */
 168 void *WMHashInsert(WMHashTable *table, void *key, void *data);
 169
 170 void WMHashRemove(WMHashTable *table, const void *key);
 171
 172 /* warning: do not manipulate the table while using these functions */
 173 WMHashEnumerator WMEnumerateHashTable(WMHashTable *table);
 174
 175 void *WMNextHashEnumeratorItem(WMHashEnumerator *enumerator);
 176
 177 unsigned WMCountHashTable(WMHashTable *table);
 178
 179
 180
 181
 182 /* some predefined callback sets */
 183
 184 extern const WMHashTableCallbacks WMIntHashCallbacks;
 185 /* sizeof(keys) are <= sizeof(void*) */
 186
 187 extern const WMHashTableCallbacks WMStringHashCallbacks;
 188 /* keys are strings. Strings will be copied with wstrdup()
 189  * and freed with free() */
 190
 191 extern const WMHashTableCallbacks WMStringPointerHashCallbacks;
 192 /* keys are strings, bug they are not copied */
 193
 194 /*......................................................................*/
 195
 196 WMNotification *WMCreateNotification(char *name, void *object, void *clientData);
 197
 198 void WMReleaseNotification(WMNotification *notification);
 199
 200 WMNotification *WMRetainNotification(WMNotification *notification);
 201
 202 void *WMGetNotificationClientData(WMNotification *notification);
 203
 204 void *WMGetNotificationObject(WMNotification *notification);
 205
 206 char *WMGetNotificationName(WMNotification *notification);
 207
 208
 209 void WMAddNotificationObserver(WMNotificationObserverAction *observerAction,
 210                                void *observer, char *name, void *object);
 211
 212 void WMPostNotification(WMNotification *notification);
 213
 214 void WMRemoveNotificationObserver(void *observer);
 215
 216 void WMRemoveNotificationObserverWithName(void *observer, char *name,
 217                                           void *object);
 218
 219 void WMPostNotificationName(char *name, void *object, void *clientData);
 220
 221 WMNotificationQueue *WMGetDefaultNotificationQueue(void);
 222
 223 WMNotificationQueue *WMCreateNotificationQueue(void);
 224
 225 void WMDequeueNotificationMatching(WMNotificationQueue *queue, unsigned mask);
 226
 227 void WMEnqueueNotification(WMNotificationQueue *queue, WMNotification *notification,
 228                            WMPostingStyle postingStyle);
 229
 230 void WMEnqueueCoalesceNotification(WMNotificationQueue *queue,
 231                                    WMNotification *notification,
 232                                    WMPostingStyle postingStyle,
 233                                    unsigned coalesceMask);
 234
 235
 236 /*......................................................................*/
 237
 238 WMUserDefaults *WMGetStandardUserDefaults(void);
 239
 240 proplist_t WMGetUDObjectForKey(WMUserDefaults *database, char *defaultName);
 241
 242 void WMSetUDObjectForKey(WMUserDefaults *database, proplist_t object,
 243                          char *defaultName);
 244
 245 void WMRemoveUDObjectForKey(WMUserDefaults *database, char *defaultName);
 246
 247 /* you can free the returned string */
 248 char *WMGetUDStringForKey(WMUserDefaults *database, char *defaultName);
 249
 250 int WMGetUDIntegerForKey(WMUserDefaults *database, char *defaultName);
 251
 252 int WMGetUDFloatForKey(WMUserDefaults *database, char *defaultName);
 253
 254 Bool WMGetUDBoolForKey(WMUserDefaults *database, char *defaultName);
 255
 256 void WMSetUDStringForKey(WMUserDefaults *database, char *value,
 257                          char *defaultName);
 258
 259 void WMSetUDIntegerForKey(WMUserDefaults *database, int value,
 260                           char *defaultName);
 261
 262 void WMSetUDFloatForKey(WMUserDefaults *database, float value,
 263                         char *defaultName);
 264
 265 void WMSetUDBoolForKey(WMUserDefaults *database, Bool value,
 266                        char *defaultName);
 267
 268 proplist_t WMGetUDSearchList(WMUserDefaults *database);
 269
 270 void WMSetUDSearchList(WMUserDefaults *database, proplist_t list);
 271
 272
 273
 274 #endif