]>
Commit | Line | Data |
---|---|---|
c801d85f KB |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: utils.h | |
3 | // Purpose: Miscellaneous utilities | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 29/01/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998 Julian Smart | |
3f4a0c5b | 9 | // Licence: wxWindows license |
c801d85f KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
34138703 JS |
12 | #ifndef _WX_UTILSH__ |
13 | #define _WX_UTILSH__ | |
c801d85f KB |
14 | |
15 | #ifdef __GNUG__ | |
16 | #pragma interface "utils.h" | |
17 | #endif | |
18 | ||
19 | #include "wx/setup.h" | |
20 | #include "wx/object.h" | |
21 | #include "wx/list.h" | |
22 | #include "wx/window.h" | |
23 | #include "wx/filefn.h" | |
24 | ||
3f4a0c5b | 25 | #include "wx/ioswrap.h" |
c801d85f | 26 | |
1f916a19 | 27 | class WXDLLEXPORT wxProcess; |
18fd783c | 28 | |
c801d85f KB |
29 | #ifdef __X__ |
30 | #ifndef __VMS__ | |
31 | /*steve: these two are not known under VMS */ | |
32 | #include <dirent.h> | |
33 | #include <unistd.h> | |
34 | #endif | |
35 | #endif | |
36 | ||
37 | #include <stdio.h> | |
38 | ||
39 | #ifdef __GNUWIN32__ | |
40 | #define stricmp strcasecmp | |
41 | #define strnicmp strncasecmp | |
42 | #endif | |
43 | ||
44 | // Forward declaration | |
45 | class WXDLLEXPORT wxFrame; | |
46 | ||
47 | // Stupid ASCII macros | |
48 | #define wxToUpper(C) (((C) >= 'a' && (C) <= 'z')? (C) - 'a' + 'A': (C)) | |
49 | #define wxToLower(C) (((C) >= 'A' && (C) <= 'Z')? (C) - 'A' + 'a': (C)) | |
50 | ||
51 | // Return a string with the current date/time | |
afb74891 | 52 | WXDLLEXPORT wxString wxNow(); |
c801d85f KB |
53 | |
54 | // Make a copy of this string using 'new' | |
184b5d99 | 55 | WXDLLEXPORT char* copystring(const char *s); |
c801d85f KB |
56 | |
57 | // Generate a unique ID | |
afb74891 | 58 | WXDLLEXPORT long wxNewId(); |
c801d85f KB |
59 | #define NewId wxNewId |
60 | ||
61 | // Ensure subsequent IDs don't clash with this one | |
184b5d99 | 62 | WXDLLEXPORT void wxRegisterId(long id); |
c801d85f KB |
63 | #define RegisterId wxRegisterId |
64 | ||
65 | // Return the current ID | |
afb74891 | 66 | WXDLLEXPORT long wxGetCurrentId(); |
c801d85f KB |
67 | |
68 | // Useful buffer | |
69 | WXDLLEXPORT_DATA(extern char*) wxBuffer; | |
70 | ||
71 | WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr; | |
72 | WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr; | |
73 | ||
74 | // Various conversions | |
184b5d99 JS |
75 | WXDLLEXPORT void StringToFloat(char *s, float *number); |
76 | WXDLLEXPORT char* FloatToString(float number, const char *fmt = wxFloatToStringStr); | |
77 | WXDLLEXPORT void StringToDouble(char *s, double *number); | |
78 | WXDLLEXPORT char* DoubleToString(double number, const char *fmt = wxDoubleToStringStr); | |
79 | WXDLLEXPORT void StringToInt(char *s, int *number); | |
80 | WXDLLEXPORT void StringToLong(char *s, long *number); | |
81 | WXDLLEXPORT char* IntToString(int number); | |
82 | WXDLLEXPORT char* LongToString(long number); | |
c801d85f KB |
83 | |
84 | // Matches string one within string two regardless of case | |
184b5d99 | 85 | WXDLLEXPORT bool StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE); |
c801d85f KB |
86 | |
87 | // A shorter way of using strcmp | |
88 | #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) | |
89 | ||
90 | // Convert 2-digit hex number to decimal | |
184b5d99 | 91 | WXDLLEXPORT int wxHexToDec(const wxString& buf); |
c801d85f KB |
92 | |
93 | // Convert decimal integer to 2-character hex string | |
184b5d99 JS |
94 | WXDLLEXPORT void wxDecToHex(int dec, char *buf); |
95 | WXDLLEXPORT wxString wxDecToHex(int dec); | |
c801d85f KB |
96 | |
97 | // Execute another program. Returns 0 if there was an error, a PID otherwise. | |
184b5d99 | 98 | WXDLLEXPORT long wxExecute(char **argv, bool sync = FALSE, |
c67daf87 | 99 | wxProcess *process = (wxProcess *) NULL); |
184b5d99 | 100 | WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE, |
c67daf87 | 101 | wxProcess *process = (wxProcess *) NULL); |
c801d85f KB |
102 | |
103 | #define wxSIGTERM 1 | |
104 | ||
184b5d99 | 105 | WXDLLEXPORT int wxKill(long pid, int sig=wxSIGTERM); |
c801d85f KB |
106 | |
107 | // Execute a command in an interactive shell window | |
108 | // If no command then just the shell | |
62448488 | 109 | WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString); |
c801d85f KB |
110 | |
111 | // Sleep for nSecs seconds under UNIX, do nothing under Windows | |
184b5d99 | 112 | WXDLLEXPORT void wxSleep(int nSecs); |
c801d85f | 113 | |
afb74891 VZ |
114 | // Sleep for a given amount of milliseconds |
115 | WXDLLEXPORT void wxUsleep(unsigned long milliseconds); | |
116 | ||
c801d85f | 117 | // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX) |
afb74891 | 118 | WXDLLEXPORT long wxGetFreeMemory(); |
c801d85f KB |
119 | |
120 | // Consume all events until no more left | |
afb74891 | 121 | WXDLLEXPORT void wxFlushEvents(); |
c801d85f KB |
122 | |
123 | /* | |
124 | * Network and username functions. | |
125 | * | |
126 | */ | |
127 | ||
128 | // Get eMail address | |
184b5d99 | 129 | WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize); |
c801d85f KB |
130 | |
131 | // Get hostname. | |
184b5d99 | 132 | WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize); |
e2a6f233 | 133 | WXDLLEXPORT bool wxGetHostName(wxString& buf); |
c801d85f KB |
134 | |
135 | // Get user ID e.g. jacs | |
184b5d99 | 136 | WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize); |
e2a6f233 | 137 | WXDLLEXPORT bool wxGetUserId(wxString& buf); |
c801d85f KB |
138 | |
139 | // Get user name e.g. Julian Smart | |
184b5d99 | 140 | WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize); |
e2a6f233 | 141 | WXDLLEXPORT bool wxGetUserName(wxString& buf); |
c801d85f KB |
142 | |
143 | /* | |
144 | * Strip out any menu codes | |
145 | */ | |
184b5d99 JS |
146 | WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL); |
147 | WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str); | |
c801d85f KB |
148 | |
149 | // Find the window/widget with the given title or label. | |
150 | // Pass a parent to begin the search from, or NULL to look through | |
151 | // all windows. | |
184b5d99 | 152 | WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL); |
c801d85f KB |
153 | |
154 | // Find window by name, and if that fails, by label. | |
184b5d99 | 155 | WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL); |
c801d85f KB |
156 | |
157 | // Returns menu item id or -1 if none. | |
184b5d99 | 158 | WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString); |
c801d85f | 159 | |
c801d85f KB |
160 | /* |
161 | #if (!defined(__MINMAX_DEFINED) && !defined(max)) | |
162 | #define max(a,b) (((a) > (b)) ? (a) : (b)) | |
163 | #define min(a,b) (((a) < (b)) ? (a) : (b)) | |
164 | #define __MINMAX_DEFINED 1 | |
165 | #endif | |
166 | */ | |
d524867f | 167 | |
c801d85f KB |
168 | #define wxMax(a,b) (((a) > (b)) ? (a) : (b)) |
169 | #define wxMin(a,b) (((a) < (b)) ? (a) : (b)) | |
170 | ||
171 | // Yield to other apps/messages | |
afb74891 | 172 | WXDLLEXPORT bool wxYield(); |
c801d85f | 173 | |
ead7ce10 KB |
174 | // Yield to other apps/messages and disable user input |
175 | WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL); | |
176 | ||
c801d85f KB |
177 | // Format a message on the standard error (UNIX) or the debugging |
178 | // stream (Windows) | |
184b5d99 | 179 | WXDLLEXPORT void wxDebugMsg(const char *fmt ...) ; |
c801d85f KB |
180 | |
181 | // Sound the bell | |
184b5d99 | 182 | WXDLLEXPORT void wxBell(void) ; |
c801d85f KB |
183 | |
184 | // Get OS version | |
184b5d99 | 185 | WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ; |
c801d85f KB |
186 | |
187 | // Set the cursor to the busy cursor for all windows | |
188 | class WXDLLEXPORT wxCursor; | |
189 | WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR; | |
184b5d99 | 190 | WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR); |
e2a6f233 | 191 | |
c801d85f | 192 | // Restore cursor to normal |
afb74891 | 193 | WXDLLEXPORT void wxEndBusyCursor(); |
c801d85f KB |
194 | |
195 | // TRUE if we're between the above two calls | |
afb74891 | 196 | WXDLLEXPORT bool wxIsBusy(); |
c801d85f | 197 | |
e2a6f233 JS |
198 | // Convenience class so we can just create a wxBusyCursor object on the stack |
199 | class WXDLLEXPORT wxBusyCursor | |
200 | { | |
afb74891 VZ |
201 | public: |
202 | wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR) | |
203 | { wxBeginBusyCursor(cursor); } | |
204 | ~wxBusyCursor() | |
205 | { wxEndBusyCursor(); } | |
e2a6f233 JS |
206 | }; |
207 | ||
afb74891 | 208 | // Error message functions used by wxWindows |
c801d85f KB |
209 | |
210 | // Non-fatal error (continues) | |
211 | WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr; | |
184b5d99 | 212 | WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr); |
c801d85f KB |
213 | |
214 | // Fatal error (exits) | |
215 | WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr; | |
184b5d99 | 216 | WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr); |
c801d85f KB |
217 | |
218 | // Reading and writing resources (eg WIN.INI, .Xdefaults) | |
47d67540 | 219 | #if wxUSE_RESOURCES |
62448488 JS |
220 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = wxEmptyString); |
221 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = wxEmptyString); | |
222 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = wxEmptyString); | |
223 | WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = wxEmptyString); | |
224 | ||
225 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, char **value, const wxString& file = wxEmptyString); | |
226 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = wxEmptyString); | |
227 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = wxEmptyString); | |
228 | WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = wxEmptyString); | |
47d67540 | 229 | #endif // wxUSE_RESOURCES |
c801d85f | 230 | |
7c3c5ecc | 231 | // Get current Home dir and copy to dest (returns pstr->c_str()) |
184b5d99 | 232 | WXDLLEXPORT const char* wxGetHomeDir(wxString *pstr); |
7c3c5ecc | 233 | |
c801d85f KB |
234 | // Get the user's home dir (caller must copy--- volatile) |
235 | // returns NULL is no HOME dir is known | |
62448488 | 236 | WXDLLEXPORT char* wxGetUserHome(const wxString& user = wxEmptyString); |
c801d85f KB |
237 | |
238 | // Check whether this window wants to process messages, e.g. Stop button | |
239 | // in long calculations. | |
184b5d99 | 240 | WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd); |
c801d85f KB |
241 | |
242 | void WXDLLEXPORT wxGetMousePosition( int* x, int* y ); | |
243 | ||
244 | // MSW only: get user-defined resource from the .res file. | |
245 | // Returns NULL or newly-allocated memory, so use delete[] to clean up. | |
2049ba38 | 246 | #ifdef __WXMSW__ |
184b5d99 JS |
247 | WXDLLEXPORT extern const char* wxUserResourceStr; |
248 | WXDLLEXPORT char* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr); | |
c030b70f JS |
249 | |
250 | // Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard | |
251 | // input/output | |
252 | WXDLLEXPORT void wxRedirectIOToConsole(); | |
253 | ||
c801d85f KB |
254 | #endif |
255 | ||
256 | // X only | |
257 | #ifdef __X__ | |
46ccb510 | 258 | WXDisplay *wxGetDisplay(); |
c801d85f | 259 | bool wxSetDisplay(const wxString& display_name); |
46ccb510 | 260 | wxString wxGetDisplayName(); |
c801d85f KB |
261 | #endif |
262 | ||
263 | #ifdef __X__ | |
264 | ||
265 | #include <X11/Xlib.h> | |
266 | ||
267 | #define wxMAX_RGB 0xff | |
268 | #define wxMAX_SV 1000 | |
269 | #define wxSIGN(x) ((x < 0) ? -x : x) | |
270 | #define wxH_WEIGHT 4 | |
271 | #define wxS_WEIGHT 1 | |
272 | #define wxV_WEIGHT 2 | |
273 | ||
274 | typedef struct wx_hsv { | |
275 | int h,s,v; | |
276 | } wxHSV; | |
277 | ||
278 | #define wxMax3(x,y,z) ((x > y) ? ((x > z) ? x : z) : ((y > z) ? y : z)) | |
279 | #define wxMin3(x,y,z) ((x < y) ? ((x < z) ? x : z) : ((y < z) ? y : z)) | |
280 | ||
281 | #define wxMax2(x,y) ((x > y) ? x : y) | |
282 | #define wxMin2(x,y) ((x < y) ? x : y) | |
283 | ||
284 | void wxHSVToXColor(wxHSV *hsv,XColor *xcolor); | |
285 | void wxXColorToHSV(wxHSV *hsv,XColor *xcolor); | |
286 | void wxAllocNearestColor(Display *display,Colormap colormap,XColor *xcolor); | |
287 | void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor); | |
288 | ||
289 | #endif //__X__ | |
290 | ||
291 | #endif | |
34138703 | 292 | // _WX_UTILSH__ |