]> git.saurik.com Git - wxWidgets.git/blob - src/os2/utils.cpp
final sweep over docs - replace & with \&
[wxWidgets.git] / src / os2 / utils.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: utils.cpp
3 // Purpose: Various utilities
4 // Author: David Webster
5 // Modified by:
6 // Created: 09/17/99
7 // RCS-ID: $Id$
8 // Copyright: (c) David Webster
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
14
15 #ifndef WX_PRECOMP
16 #include "wx/setup.h"
17 #include "wx/utils.h"
18 #include "wx/app.h"
19 #endif //WX_PRECOMP
20
21 #include "wx/os2/private.h"
22 #include "wx/intl.h"
23 #include "wx/apptrait.h"
24
25 #include <ctype.h>
26 #ifdef __EMX__
27 #include <dirent.h>
28 #endif
29
30 #include "wx/log.h"
31
32 #include <io.h>
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <errno.h>
38 #include <stdarg.h>
39
40 #define PURE_32
41
42 #ifndef __EMX__
43 #include <upm.h>
44 #include <netcons.h>
45 #include <netbios.h>
46 #endif
47
48 static const wxChar WX_SECTION[] = _T("wxWidgets");
49 static const wxChar eHOSTNAME[] = _T("HostName");
50 static const wxChar eUSERID[] = _T("UserId");
51 static const wxChar eUSERNAME[] = _T("UserName");
52
53 // For the following functions we SHOULD fill in support
54 // for Windows-NT (which I don't know) as I assume it begin
55 // a POSIX Unix (so claims MS) that it has some special
56 // functions beyond those provided by WinSock
57
58 // Get full hostname (eg. DoDo.BSn-Germany.crg.de)
59 bool wxGetHostName(
60 wxChar* zBuf
61 , int nMaxSize
62 )
63 {
64 #if wxUSE_NET_API
65 char zServer[256];
66 char zComputer[256];
67 unsigned long ulLevel = 0;
68 unsigned char* zBuffer = NULL;
69 unsigned long ulBuffer = 256;
70 unsigned long* pulTotalAvail = NULL;
71
72 NetBios32GetInfo( (const unsigned char*)zServer
73 ,(const unsigned char*)zComputer
74 ,ulLevel
75 ,zBuffer
76 ,ulBuffer
77 ,pulTotalAvail
78 );
79 strcpy(zBuf, zServer);
80 #else
81 wxChar* zSysname;
82 const wxChar* zDefaultHost = _T("noname");
83
84 if ((zSysname = wxGetenv(_T("SYSTEM_NAME"))) == NULL)
85 {
86 ::PrfQueryProfileString( HINI_PROFILE
87 ,(PSZ)WX_SECTION
88 ,(PSZ)eHOSTNAME
89 ,(PSZ)zDefaultHost
90 ,(void*)zBuf
91 ,(ULONG)nMaxSize - 1
92 );
93 }
94 else
95 wxStrncpy(zBuf, zSysname, nMaxSize - 1);
96 zBuf[nMaxSize] = _T('\0');
97 #endif
98 return *zBuf ? TRUE : FALSE;
99 }
100
101 // Get user ID e.g. jacs
102 bool wxGetUserId(
103 wxChar* zBuf
104 , int nType
105 )
106 {
107 #if defined(__VISAGECPP__)
108 long lrc;
109 // UPM procs return 0 on success
110 lrc = U32ELOCU((unsigned char*)zBuf, (unsigned long *)&nType);
111 if (lrc == 0) return TRUE;
112 #endif
113 return FALSE;
114 }
115
116 bool wxGetUserName(
117 wxChar* zBuf
118 , int nMaxSize
119 )
120 {
121 #ifdef USE_NET_API
122 wxGetUserId( zBuf
123 ,nMaxSize
124 );
125 #else
126 wxStrncpy(zBuf, _T("Unknown User"), nMaxSize);
127 #endif
128 return TRUE;
129 }
130
131 int wxKill(
132 long lPid
133 , wxSignal eSig
134 , wxKillError* peError
135 )
136 {
137 return((int)::DosKillProcess(0, (PID)lPid));
138 }
139
140 //
141 // Execute a program in an Interactive Shell
142 //
143 bool wxShell(
144 const wxString& rCommand
145 )
146 {
147 wxChar* zShell = _T("CMD.EXE");
148 wxString sInputs;
149 STARTDATA SData = {0};
150 PSZ PgmTitle = "Command Shell";
151 APIRET rc;
152 PID vPid = 0;
153 ULONG ulSessID = 0;
154 UCHAR achObjBuf[256] = {0}; //error data if DosStart fails
155 RESULTCODES vResult;
156
157 SData.Length = sizeof(STARTDATA);
158 SData.Related = SSF_RELATED_INDEPENDENT;
159 SData.FgBg = SSF_FGBG_FORE;
160 SData.TraceOpt = SSF_TRACEOPT_NONE;
161 SData.PgmTitle = PgmTitle;
162 SData.PgmName = zShell;
163
164 sInputs = "/C " + rCommand;
165 SData.PgmInputs = (BYTE*)sInputs.c_str();
166 SData.TermQ = 0;
167 SData.Environment = 0;
168 SData.InheritOpt = SSF_INHERTOPT_SHELL;
169 SData.SessionType = SSF_TYPE_WINDOWABLEVIO;
170 SData.IconFile = 0;
171 SData.PgmHandle = 0;
172 SData.PgmControl = SSF_CONTROL_VISIBLE | SSF_CONTROL_MAXIMIZE;
173 SData.InitXPos = 30;
174 SData.InitYPos = 40;
175 SData.InitXSize = 200;
176 SData.InitYSize = 140;
177 SData.Reserved = 0;
178 SData.ObjectBuffer = (char*)achObjBuf;
179 SData.ObjectBuffLen = (ULONG)sizeof(achObjBuf);
180
181 rc = ::DosStartSession(&SData, &ulSessID, &vPid);
182 if (rc == 0 || rc == 457) // NO_ERROR or SMG_START_IN_BACKGROUND
183 {
184 PTIB ptib;
185 PPIB ppib;
186
187 ::DosGetInfoBlocks(&ptib, &ppib);
188
189 ::DosWaitChild( DCWA_PROCESS
190 ,DCWW_WAIT
191 ,&vResult
192 ,&ppib->pib_ulpid
193 ,vPid
194 );
195 }
196 return (rc != 0);
197 }
198
199 // Shutdown or reboot the PC
200 bool wxShutdown(wxShutdownFlags wFlags)
201 {
202 // TODO
203 return FALSE;
204 }
205
206 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
207 long wxGetFreeMemory()
208 {
209 void* pMemptr = NULL;
210 ULONG lSize;
211 ULONG lMemFlags;
212 APIRET rc;
213
214 lMemFlags = PAG_FREE;
215 rc = ::DosQueryMem(pMemptr, &lSize, &lMemFlags);
216 if (rc != 0)
217 return -1L;
218 return (long)lSize;
219 }
220
221 // ----------------------------------------------------------------------------
222 // env vars
223 // ----------------------------------------------------------------------------
224
225 bool wxGetEnv(const wxString& var, wxString *value)
226 {
227 // wxGetenv is defined as getenv()
228 wxChar *p = wxGetenv(var);
229 if ( !p )
230 return FALSE;
231
232 if ( value )
233 {
234 *value = p;
235 }
236
237 return TRUE;
238 }
239
240 bool wxSetEnv(const wxString& variable, const wxChar *value)
241 {
242 #if defined(HAVE_SETENV)
243 return setenv(variable.mb_str(), value ? wxString(value).mb_str().data()
244 : NULL, 1 /* overwrite */) == 0;
245 #elif defined(HAVE_PUTENV)
246 wxString s = variable;
247 if ( value )
248 s << _T('=') << value;
249
250 // transform to ANSI
251 const char *p = s.mb_str();
252
253 // the string will be free()d by libc
254 char *buf = (char *)malloc(strlen(p) + 1);
255 strcpy(buf, p);
256
257 return putenv(buf) == 0;
258 #else // no way to set an env var
259 return FALSE;
260 #endif
261 }
262
263 void wxMilliSleep(
264 unsigned long ulMilliseconds
265 )
266 {
267 ::DosSleep(ulMilliseconds);
268 }
269
270 void wxMicroSleep(
271 unsigned long ulMicroseconds
272 )
273 {
274 ::DosSleep(ulMicroseconds/1000);
275 }
276
277 void wxSleep(
278 int nSecs
279 )
280 {
281 ::DosSleep(1000 * nSecs);
282 }
283
284 // Consume all events until no more left
285 void wxFlushEvents()
286 {
287 // wxYield();
288 }
289
290 #if WXWIN_COMPATIBILITY_2_2
291
292 // Output a debug mess., in a system dependent fashion.
293 void wxDebugMsg(
294 const wxChar* zFmt ...
295 )
296 {
297 va_list vAp;
298 static wxChar zBuffer[512];
299
300 if (!wxTheApp->GetWantDebugOutput())
301 return ;
302 va_start(vAp, zFmt);
303 sprintf(zBuffer, zFmt, vAp) ;
304 va_end(vAp);
305 }
306
307 // Non-fatal error: pop up message box and (possibly) continue
308 void wxError(
309 const wxString& rMsg
310 , const wxString& rTitle
311 )
312 {
313 wxChar *wxBuffer = new wxChar[256];
314 wxSprintf(wxBuffer, "%s\nContinue?", WXSTRINGCAST rMsg);
315 if (::WinMessageBox( HWND_DESKTOP
316 ,NULL
317 ,(PSZ)wxBuffer
318 ,(PSZ)WXSTRINGCAST rTitle
319 ,0
320 ,MB_ICONEXCLAMATION | MB_YESNO
321 ) == MBID_YES)
322 delete[] wxBuffer;
323 wxExit();
324 }
325
326 // Fatal error: pop up message box and abort
327 void wxFatalError(
328 const wxString& rMsg
329 , const wxString& rTitle
330 )
331 {
332 unsigned long ulRc;
333
334 ulRc = ::WinMessageBox( HWND_DESKTOP
335 ,NULL
336 ,WXSTRINGCAST rMsg
337 ,WXSTRINGCAST rTitle
338 ,0
339 ,MB_NOICON | MB_OK
340 );
341 DosExit(EXIT_PROCESS, ulRc);
342 }
343
344 #endif // WXWIN_COMPATIBILITY_2_2
345
346 // Emit a beeeeeep
347 void wxBell()
348 {
349 DosBeep(1000,1000); // 1kHz during 1 sec.
350 }
351
352
353 void wxAppTraits::InitializeGui(unsigned long &ulHab)
354 {
355 }
356
357 void wxAppTraits::TerminateGui(unsigned long ulHab)
358 {
359 }
360
361 wxToolkitInfo & wxConsoleAppTraits::GetToolkitInfo()
362 {
363 static wxToolkitInfo vInfo;
364 ULONG ulSysInfo[QSV_MAX] = {0};
365 APIRET ulrc;
366
367 vInfo.name = _T("wxBase");
368 ulrc = ::DosQuerySysInfo( 1L
369 ,QSV_MAX
370 ,(PVOID)ulSysInfo
371 ,sizeof(ULONG) * QSV_MAX
372 );
373 if (ulrc == 0L)
374 {
375 vInfo.versionMajor = ulSysInfo[QSV_VERSION_MAJOR] / 10;
376 vInfo.versionMinor = ulSysInfo[QSV_VERSION_MINOR];
377 }
378 vInfo.os = wxOS2_PM;
379 return vInfo;
380 }
381
382 // ---------------------------------------------------------------------------
383 const wxChar* wxGetHomeDir(
384 wxString* pStr
385 )
386 {
387 wxString& rStrDir = *pStr;
388
389 // OS/2 has no idea about home,
390 // so use the working directory instead.
391 // However, we might have a valid HOME directory,
392 // as is used on many machines that have unix utilities
393 // on them, so we should use that, if available.
394
395 // 256 was taken from os2def.h
396 #ifndef MAX_PATH
397 # define MAX_PATH 256
398 #endif
399
400 const wxChar *szHome = wxGetenv("HOME");
401 if ( szHome == NULL ) {
402 // we're homeless, use current directory.
403 rStrDir = wxT(".");
404 }
405 else
406 rStrDir = szHome;
407
408 return rStrDir.c_str();
409 }
410
411 // Hack for OS/2
412 wxChar* wxGetUserHome (
413 const wxString& rUser
414 )
415 {
416 wxChar* zHome;
417 wxString sUser1(rUser);
418
419 char *wxBuffer = new wxChar[256];
420 #ifndef __EMX__
421 if (sUser1 != _T(""))
422 {
423 wxChar zTmp[64];
424
425 if (wxGetUserId( zTmp
426 ,sizeof(zTmp)/sizeof(char)
427 ))
428 {
429 // Guests belong in the temp dir
430 if (wxStricmp(zTmp, _T("annonymous")) == 0)
431 {
432 if ((zHome = wxGetenv(_T("TMP"))) != NULL ||
433 (zHome = wxGetenv(_T("TMPDIR"))) != NULL ||
434 (zHome = wxGetenv(_T("TEMP"))) != NULL)
435 delete[] wxBuffer;
436 return *zHome ? zHome : (wxChar*)_T("\\");
437 }
438 if (wxStricmp(zTmp, WXSTRINGCAST sUser1) == 0)
439 sUser1 = _T("");
440 }
441 }
442 #endif
443 if (sUser1 == _T(""))
444 {
445 if ((zHome = wxGetenv(_T("HOME"))) != NULL)
446 {
447 wxStrcpy(wxBuffer, zHome);
448 wxUnix2DosFilename(wxBuffer);
449 wxStrcpy(zHome, wxBuffer);
450 delete[] wxBuffer;
451 return zHome;
452 }
453 }
454 delete[] wxBuffer;
455 return NULL; // No home known!
456 }
457
458 bool wxDirExists(
459 const wxString& rDir
460 )
461 {
462 return (::DosSetCurrentDir(WXSTRINGCAST rDir));
463 }
464
465 wxString WXDLLEXPORT wxPMErrorToStr(
466 ERRORID vError
467 )
468 {
469 wxString sError;
470
471 //
472 // Remove the high order byte -- it is useless
473 //
474 vError &= 0x0000ffff;
475 switch(vError)
476 {
477 case PMERR_INVALID_HWND:
478 sError = wxT("Invalid window handle specified");
479 break;
480
481 case PMERR_INVALID_FLAG:
482 sError = wxT("Invalid flag bit set");
483 break;
484
485 case PMERR_NO_MSG_QUEUE:
486 sError = wxT("No message queue available");
487 break;
488
489 case PMERR_INVALID_PARM:
490 sError = wxT("Parameter contained invalid data");
491 break;
492
493 case PMERR_INVALID_PARAMETERS:
494 sError = wxT("Parameter value is out of range");
495 break;
496
497 case PMERR_PARAMETER_OUT_OF_RANGE:
498 sError = wxT("Parameter value is out of range");
499 break;
500
501 case PMERR_INVALID_INTEGER_ATOM:
502 sError = wxT("Not a valid atom");
503 break;
504
505 case PMERR_INVALID_HATOMTBL:
506 sError = wxT("Atom table handle is invalid");
507 break;
508
509 case PMERR_INVALID_ATOM_NAME:
510 sError = wxT("Not a valid atom name");
511 break;
512
513 case PMERR_ATOM_NAME_NOT_FOUND:
514 sError = wxT("Valid name format, but cannot find name in atom table");
515 break;
516
517 default:
518 sError = wxT("Unknown error");
519 }
520 return(sError);
521 } // end of wxPMErrorToStr
522
523 // replacement for implementation in unix/utilsunx.cpp,
524 // to be used by all X11 based ports.
525 struct wxEndProcessData;
526
527 void wxHandleProcessTermination(wxEndProcessData *proc_data)
528 {
529 // For now, just do nothing. To be filled in as needed.
530 }