Fix another crash when conversion fails in Unix PostScript code.

[wxWidgets.git] / src / os2 / utils.cpp

diff --git a/src/os2/utils.cpp b/src/os2/utils.cpp
index ccf622b9a29c4a6404779605428460fd02d952ed..50a68b9b49270726996d870e920aa364bf1d0488 100644 (file)
--- a/src/os2/utils.cpp
+++ b/src/os2/utils.cpp
@@ -1,10 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        utils.cpp
+// Name:        src/os2/utils.cpp

 // Purpose:     Various utilities
 // Author:      David Webster
 // Modified by:
 // Created:     09/17/99
 // Purpose:     Various utilities
 // Author:      David Webster
 // Modified by:
 // Created:     09/17/99

-// RCS-ID:      $Id$

 // Copyright:   (c) David Webster
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) David Webster
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -12,22 +11,22 @@
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

+#include "wx/utils.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/setup.h"
-    #include "wx/utils.h"
-    #include "wx/app.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"

 #endif  //WX_PRECOMP
 
 #include "wx/os2/private.h"
 #endif  //WX_PRECOMP
 
 #include "wx/os2/private.h"

-#include "wx/intl.h"

 #include "wx/apptrait.h"
 #include "wx/apptrait.h"

+#include "wx/filename.h"

 
 #include <ctype.h>
 #ifdef __EMX__
 #include <dirent.h>
 #endif
 
 
 #include <ctype.h>
 #ifdef __EMX__
 #include <dirent.h>
 #endif
 

-#include "wx/log.h"

 
 #include <io.h>
 
 
 #include <io.h>
 


@@ -50,8 +49,8 @@ extern "C"
     #include <netbios.h>
 #endif
 
     #include <netbios.h>
 #endif
 

-static const wxChar WX_SECTION[] = _T("wxWidgets");
-static const wxChar eHOSTNAME[]  = _T("HostName");
+static const wxChar WX_SECTION[] = wxT("wxWidgets");
+static const wxChar eHOSTNAME[]  = wxT("HostName");

 
 // For the following functions we SHOULD fill in support
 // for Windows-NT (which I don't know) as I assume it begin
 
 // For the following functions we SHOULD fill in support
 // for Windows-NT (which I don't know) as I assume it begin


@@ -59,18 +58,17 @@ static const wxChar eHOSTNAME[]  = _T("HostName");
 // functions beyond those provided by WinSock
 
 // Get full hostname (eg. DoDo.BSn-Germany.crg.de)
 // functions beyond those provided by WinSock
 
 // Get full hostname (eg. DoDo.BSn-Germany.crg.de)

-bool wxGetHostName(
-  wxChar*                           zBuf
-, int                               nMaxSize
-)
+bool wxGetHostName( wxChar* zBuf, int nMaxSize )

 {
 {

-#if wxUSE_NET_API
-    char                            zServer[256];
-    char                            zComputer[256];
-    unsigned long                   ulLevel = 0;
-    unsigned char*                  zBuffer = NULL;
-    unsigned long                   ulBuffer = 256;
-    unsigned long*                  pulTotalAvail = NULL;
+    if (!zBuf) return false;
+
+#if defined(wxUSE_NET_API) && wxUSE_NET_API
+    char           zServer[256];
+    char           zComputer[256];
+    unsigned long  ulLevel = 0;
+    unsigned char* zBuffer = NULL;
+    unsigned long  ulBuffer = 256;
+    unsigned long* pulTotalAvail = NULL;

 
     NetBios32GetInfo( (const unsigned char*)zServer
                      ,(const unsigned char*)zComputer
 
     NetBios32GetInfo( (const unsigned char*)zServer
                      ,(const unsigned char*)zComputer


@@ -81,10 +79,11 @@ bool wxGetHostName(
                     );
     strcpy(zBuf, zServer);
 #else
                     );
     strcpy(zBuf, zServer);
 #else

-    wxChar*                         zSysname;
-    const wxChar*                   zDefaultHost = _T("noname");
+    wxChar*        zSysname;
+    const wxChar*  zDefaultHost = wxT("noname");

 
 

-    if ((zSysname = wxGetenv(_T("SYSTEM_NAME"))) == NULL)
+    if ((zSysname = wxGetenv(wxT("SYSTEM_NAME"))) == NULL &&
+            (zSysname = wxGetenv(wxT("HOSTNAME"))) == NULL)

     {
         ::PrfQueryProfileString( HINI_PROFILE
                                 ,(PSZ)WX_SECTION
     {
         ::PrfQueryProfileString( HINI_PROFILE
                                 ,(PSZ)WX_SECTION


@@ -93,11 +92,14 @@ bool wxGetHostName(
                                 ,(void*)zBuf
                                 ,(ULONG)nMaxSize - 1
                                );
                                 ,(void*)zBuf
                                 ,(ULONG)nMaxSize - 1
                                );

+        zBuf[nMaxSize] = wxT('\0');

     }
     else
     }
     else

-        wxStrncpy(zBuf, zSysname, nMaxSize - 1);
-    zBuf[nMaxSize] = _T('\0');
+    {
+        wxStrlcpy(zBuf, zSysname, nMaxSize);
+    }

 #endif
 #endif

+

     return *zBuf ? true : false;
 }
 
     return *zBuf ? true : false;
 }
 


@@ -117,7 +119,7 @@ bool wxGetUserName( wxChar* zBuf, int nMaxSize )
 #ifdef USE_NET_API
     wxGetUserId( zBuf, nMaxSize );
 #else
 #ifdef USE_NET_API
     wxGetUserId( zBuf, nMaxSize );
 #else

-    wxStrncpy(zBuf, _T("Unknown User"), nMaxSize);
+    wxStrlcpy(zBuf, wxT("Unknown User"), nMaxSize);

 #endif
     return true;
 }
 #endif
     return true;
 }


@@ -133,19 +135,17 @@ int wxKill(long         lPid,
 //
 // Execute a program in an Interactive Shell
 //
 //
 // Execute a program in an Interactive Shell
 //

-bool wxShell(
-  const wxString&                   rCommand
-)
+bool wxShell( const wxString& rCommand )

 {
 {

-    wxChar*                         zShell = _T("CMD.EXE");
-    wxString                        sInputs;
-    STARTDATA                       SData = {0};
-    PSZ                             PgmTitle = "Command Shell";
-    APIRET                          rc;
-    PID                             vPid = 0;
-    ULONG                           ulSessID = 0;
-    UCHAR                           achObjBuf[256] = {0}; //error data if DosStart fails
-    RESULTCODES                     vResult;
+    wxChar*     zShell = wxT("CMD.EXE");
+    wxString    sInputs;
+    STARTDATA   SData = {0};
+    PSZ         PgmTitle = "Command Shell";
+    APIRET      rc;
+    PID         vPid = 0;
+    ULONG       ulSessID = 0;
+    UCHAR       achObjBuf[256] = {0}; //error data if DosStart fails
+    RESULTCODES vResult;

 
     SData.Length   = sizeof(STARTDATA);
     SData.Related  = SSF_RELATED_INDEPENDENT;
 
     SData.Length   = sizeof(STARTDATA);
     SData.Related  = SSF_RELATED_INDEPENDENT;


@@ -154,8 +154,8 @@ bool wxShell(
     SData.PgmTitle = PgmTitle;
     SData.PgmName  = (char*)zShell;
 
     SData.PgmTitle = PgmTitle;
     SData.PgmName  = (char*)zShell;
 

-    sInputs = _T("/C ") + rCommand;
-    SData.PgmInputs     = (BYTE*)sInputs.c_str();
+    sInputs = wxT("/C ") + rCommand;
+    SData.PgmInputs     = (BYTE*)sInputs.wx_str();

     SData.TermQ         = 0;
     SData.Environment   = 0;
     SData.InheritOpt    = SSF_INHERTOPT_SHELL;
     SData.TermQ         = 0;
     SData.Environment   = 0;
     SData.InheritOpt    = SSF_INHERTOPT_SHELL;


@@ -196,18 +196,6 @@ bool wxShutdown(wxShutdownFlags WXUNUSED(wFlags))
     return false;
 }
 
     return false;
 }
 

-wxPowerType wxGetPowerType()
-{
-    // TODO
-    return wxPOWER_UNKNOWN;
-}
-
-wxBatteryState wxGetBatteryState()
-{
-    // TODO
-    return wxBATTERY_UNKNOWN_STATE;
-}
-

 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 wxMemorySize wxGetFreeMemory()
 {
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 wxMemorySize wxGetFreeMemory()
 {


@@ -236,7 +224,7 @@ unsigned long wxGetProcessId()
 bool wxGetEnv(const wxString& var, wxString *value)
 {
     // wxGetenv is defined as getenv()
 bool wxGetEnv(const wxString& var, wxString *value)
 {
     // wxGetenv is defined as getenv()

-    wxChar *p = wxGetenv(var);
+    wxChar *p = wxGetenv((const wxChar *)var);

     if ( !p )
         return false;
 
     if ( !p )
         return false;
 


@@ -248,15 +236,22 @@ bool wxGetEnv(const wxString& var, wxString *value)
     return true;
 }
 
     return true;
 }
 

-bool wxSetEnv(const wxString& variable, const wxChar *value)
+static bool wxDoSetEnv(const wxString& variable, const char *value)

 {
 #if defined(HAVE_SETENV)
 {
 #if defined(HAVE_SETENV)

-    return setenv(variable.mb_str(), value ? wxString(value).mb_str().data()
-                                           : NULL, 1 /* overwrite */) == 0;
+    if ( !value )
+    {
+#ifdef HAVE_UNSETENV
+        return unsetenv(variable.mb_str()) == 0;
+#else
+        value = wxT(""); // mustn't pass NULL to setenv()
+#endif
+    }
+    return setenv(variable.mb_str(), value, 1 /* overwrite */) == 0;

 #elif defined(HAVE_PUTENV)
     wxString s = variable;
     if ( value )
 #elif defined(HAVE_PUTENV)
     wxString s = variable;
     if ( value )

-        s << _T('=') << value;
+        s << wxT('=') << value;

 
     // transform to ANSI
     const char *p = s.mb_str();
 
     // transform to ANSI
     const char *p = s.mb_str();


@@ -273,6 +268,16 @@ bool wxSetEnv(const wxString& variable, const wxChar *value)
 #endif
 }
 
 #endif
 }
 

+bool wxSetEnv(const wxString& variable, const wxString& value)
+{
+    return wxDoSetEnv(variable, value.mb_str());
+}
+
+bool wxUnsetEnv(const wxString& variable)
+{
+    return wxDoSetEnv(variable, NULL);
+}
+

 void wxMilliSleep(
   unsigned long                     ulMilliseconds
 )
 void wxMilliSleep(
   unsigned long                     ulMilliseconds
 )


@@ -300,28 +305,21 @@ void wxFlushEvents()
 //  wxYield();
 }
 
 //  wxYield();
 }
 

-// Emit a beeeeeep
-void wxBell()
-{
-    DosBeep(1000,1000); // 1kHz during 1 sec.
-}
-

 wxString wxGetOsDescription()
 {
 wxString wxGetOsDescription()
 {

-    wxString strVer(_T("OS/2"));
-    ULONG ulSysInfo[QSV_MAX] = {0};
+    wxString strVer(wxT("OS/2"));
+    ULONG ulSysInfo = 0;

 
 

-    if (::DosQuerySysInfo( 1L,
-                           QSV_MAX,
-                           (PVOID)ulSysInfo,
-                           sizeof(ULONG) * QSV_MAX
+    if (::DosQuerySysInfo( QSV_VERSION_MINOR,
+                           QSV_VERSION_MINOR,
+                           (PVOID)&ulSysInfo,
+                           sizeof(ULONG)

                          ) == 0L )
     {
         wxString ver;
                          ) == 0L )
     {
         wxString ver;

-        ver.Printf( _T(" ver. %d.%d rev. %c"),
-                    int(ulSysInfo[QSV_VERSION_MAJOR] / 10),
-                    int(ulSysInfo[QSV_VERSION_MINOR]),
-                    char(ulSysInfo[QSV_VERSION_REVISION])
+        ver.Printf( wxT(" ver. %d.%d"),
+                    int(ulSysInfo / 10),
+                    int(ulSysInfo % 10)

                   );
         strVer += ver;
     }
                   );
         strVer += ver;
     }


@@ -329,6 +327,13 @@ wxString wxGetOsDescription()
     return strVer;
 }
 
     return strVer;
 }
 

+bool wxIsPlatform64Bit()
+{
+    // FIXME: No idea how to test for 64 bit processor
+    //        (Probably irrelevant anyhow, though).
+    return false;
+}
+

 void wxAppTraits::InitializeGui(unsigned long &WXUNUSED(ulHab))
 {
 }
 void wxAppTraits::InitializeGui(unsigned long &WXUNUSED(ulHab))
 {
 }


@@ -337,27 +342,29 @@ void wxAppTraits::TerminateGui(unsigned long WXUNUSED(ulHab))
 {
 }
 
 {
 }
 

-wxToolkitInfo & wxConsoleAppTraits::GetToolkitInfo()
+wxOperatingSystemId wxGetOsVersion(int *verMaj, int *verMin)

 {
 {

-    static wxToolkitInfo  vInfo;
-    ULONG                 ulSysInfo[QSV_MAX] = {0};
+    ULONG                 ulSysInfo = 0;

     APIRET                ulrc;
 
     APIRET                ulrc;
 

-    vInfo.name = _T("wxBase");
-    ulrc = ::DosQuerySysInfo( 1L
-                             ,QSV_MAX
-                             ,(PVOID)ulSysInfo
-                             ,sizeof(ULONG) * QSV_MAX
+    ulrc = ::DosQuerySysInfo( QSV_VERSION_MINOR,
+                              QSV_VERSION_MINOR,
+                              (PVOID)&ulSysInfo,
+                              sizeof(ULONG)

                             );
                             );

+

     if (ulrc == 0L)
     {
     if (ulrc == 0L)
     {

-        vInfo.versionMajor = ulSysInfo[QSV_VERSION_MAJOR] / 10;
-        vInfo.versionMinor = ulSysInfo[QSV_VERSION_MINOR];
+        if ( verMaj )
+            *verMaj = ulSysInfo / 10;
+        if ( verMin )
+            *verMin = ulSysInfo % 10;

     }
     }

-    vInfo.os = wxOS2_PM;
-    return vInfo;
+
+    return wxOS_OS2;

 }
 
 }
 

+

 // ---------------------------------------------------------------------------
 const wxChar* wxGetHomeDir(
   wxString*                         pStr
 // ---------------------------------------------------------------------------
 const wxChar* wxGetHomeDir(
   wxString*                         pStr


@@ -387,64 +394,95 @@ const wxChar* wxGetHomeDir(
     return rStrDir.c_str();
 }
 
     return rStrDir.c_str();
 }
 

-// Hack for OS/2
-#if wxUSE_UNICODE
-const wxMB2WXbuf wxGetUserHome( const wxString &rUser )
-#else // just for binary compatibility -- there is no 'const' here
-wxChar* wxGetUserHome ( const wxString &rUser )
-#endif
+wxString wxGetUserHome ( const wxString &rUser )

 {
     wxChar*    zHome;
 {
     wxChar*    zHome;

-    wxString   sUser1(rUser);
+    wxString   sUser(rUser);
+
+    wxString home;

 
 

-    wxChar *wxBuffer = new wxChar[256];

 #ifndef __EMX__
 #ifndef __EMX__

-    if (!sUser1.empty())
+    if (!sUser.empty())

     {
     {

-        wxChar                      zTmp[64];
+        const wxString currentUser = wxGetUserId();

 
 

-        if (wxGetUserId( zTmp
-                        ,sizeof(zTmp)/sizeof(char)
-                       ))
+        // Guests belong in the temp dir
+        if ( currentUser == "annonymous" )

         {
         {

-            // Guests belong in the temp dir
-            if (wxStricmp(zTmp, _T("annonymous")) == 0)
-            {
-                if ((zHome = wxGetenv(_T("TMP"))) != NULL    ||
-                    (zHome = wxGetenv(_T("TMPDIR"))) != NULL ||
-                    (zHome = wxGetenv(_T("TEMP"))) != NULL)
-                    delete[] wxBuffer;
-                    return *zHome ? zHome : (wxChar*)_T("\\");
-            }
-            if (wxStricmp(zTmp, WXSTRINGCAST sUser1) == 0)
-                sUser1 = wxEmptyString;
+            zHome = wxGetenv(wxT("TMP"));
+            if ( !zHome )
+                zHome = wxGetenv(wxT("TMPDIR"));
+            if ( !zHome )
+                zHome = wxGetenv(wxT("TEMP"));
+
+            if ( zHome && *zHome )
+                return zHome;

         }
         }

+
+        if ( sUser == currentUser )
+            sUser.clear();

     }
 #endif
     }
 #endif

-    if (sUser1.empty())
+    if (sUser.empty())

     {
     {

-        if ((zHome = wxGetenv(_T("HOME"))) != NULL)
+        if ((zHome = wxGetenv(wxT("HOME"))) != NULL)

         {
         {

-            wxStrcpy(wxBuffer, zHome);
-            wxUnix2DosFilename(wxBuffer);
-#if wxUSE_UNICODE
-            wxWCharBuffer retBuffer (wxBuffer);
-            delete[] wxBuffer;
-            return retBuffer;
-#else
-            wxStrcpy(zHome, wxBuffer);
-            delete[] wxBuffer;
-            return zHome;
-#endif
+            home = zHome;
+            home.Replace("/", "\\");
+        }
+    }
+
+    return home;
+}
+
+bool wxGetDiskSpace(const wxString& path,
+                    wxDiskspaceSize_t *pTotal,
+                    wxDiskspaceSize_t *pFree)
+{
+    if (path.empty())
+        return false;
+
+    wxFileName fn(path);
+    FSALLOCATE fsaBuf = {0};
+    APIRET rc = NO_ERROR;
+    ULONG disknum = 0;
+
+    fn.MakeAbsolute();
+
+    if (wxDirExists(fn.GetFullPath()) == false)
+        return false;
+
+    disknum = wxToupper(fn.GetVolume().GetChar(0)) - wxT('A') + 1;
+
+    rc = ::DosQueryFSInfo(disknum,             // 1 = A, 2 = B, 3 = C, ...
+                          FSIL_ALLOC,          // allocation info
+                          (PVOID)&fsaBuf,
+                          sizeof(FSALLOCATE));
+
+    if (rc != NO_ERROR)
+        return false;
+    else
+    {
+        if(pTotal)
+        {
+           // to try to avoid 32-bit overflow, let's not multiply right away
+            // (num of alloc units)
+            *pTotal = fsaBuf.cUnit;
+            // * (num of sectors per alloc unit) * (num of bytes per sector)
+            (*pTotal) *= fsaBuf.cSectorUnit * fsaBuf.cbSector;
+        }
+        if(pFree)
+        {
+            *pFree = fsaBuf.cUnitAvail;
+            (*pFree) *= fsaBuf.cSectorUnit * fsaBuf.cbSector;

         }
         }

+        return true;

     }
     }

-    delete[] wxBuffer;
-    return (wxChar*)wxEmptyString; // No home known!

 }
 
 }
 

-wxString WXDLLEXPORT wxPMErrorToStr(ERRORID vError)
+wxString wxPMErrorToStr(ERRORID vError)

 {
 {

-    wxString                        sError;
+    wxString sError;

 
     //
     // Remove the high order byte -- it is useless
 
     //
     // Remove the high order byte -- it is useless


@@ -492,17 +530,108 @@ wxString WXDLLEXPORT wxPMErrorToStr(ERRORID vError)
             sError = wxT("Valid name format, but cannot find name in atom table");
             break;
 
             sError = wxT("Valid name format, but cannot find name in atom table");
             break;
 

+        case PMERR_INV_HPS:
+            sError = wxT("PMERR_INV_HPS");
+            break;
+
+        case PMERR_PS_BUSY:
+            sError = wxT("PMERR_PS_BUSY");
+            break;
+
+        case PMERR_INV_PRIMITIVE_TYPE:
+            sError = wxT("PMERR_INV_PRIMITIVE_TYPE");
+            break;
+
+        case PMERR_UNSUPPORTED_ATTR:
+            sError = wxT("PMERR_UNSUPPORTED_ATTR");
+            break;
+
+        case PMERR_INV_COLOR_ATTR:
+            sError = wxT("PMERR_INV_COLOR_ATTR");
+            break;
+
+        case PMERR_INV_BACKGROUND_COL_ATTR:
+            sError = wxT("PMERR_INV_BACKGROUND_COL_ATTR");
+            break;
+
+        case PMERR_INV_MIX_ATTR:
+            sError = wxT("PMERR_INV_MIX_ATTR");
+            break;
+
+        case PMERR_INV_LINE_WIDTH_ATTR:
+            sError = wxT("PMERR_INV_LINE_WIDTH_ATTR");
+            break;
+
+        case PMERR_INV_GEOM_LINE_WIDTH_ATTR:
+            sError = wxT("PMERR_INV_GEOM_LINE_WIDTH_ATTR");
+            break;
+
+        case PMERR_INV_LINE_TYPE_ATTR:
+            sError = wxT("PMERR_INV_LINE_TYPE_ATTR");
+            break;
+
+        case PMERR_INV_LINE_END_ATTR:
+            sError = wxT("PMERR_INV_LINE_END_ATTR");
+            break;
+
+        case PMERR_INV_LINE_JOIN_ATTR:
+            sError = wxT("PMERR_INV_LINE_JOIN_ATTR");
+            break;
+
+        case PMERR_INV_CHAR_SET_ATTR:
+            sError = wxT("PMERR_INV_CHAR_SET_ATTR");
+            break;
+
+        case PMERR_INV_CHAR_MODE_ATTR:
+            sError = wxT("PMERR_INV_CHAR_MODE_ATTR");
+            break;
+
+        case PMERR_INV_CHAR_DIRECTION_ATTR:
+            sError = wxT("PMERR_INV_CHAR_DIRECTION_ATTR");
+            break;
+
+        case PMERR_INV_CHAR_SHEAR_ATTR:
+            sError = wxT("PMERR_INV_CHAR_SHEAR_ATTR");
+            break;
+
+        case PMERR_INV_CHAR_ANGLE_ATTR:
+            sError = wxT("PMERR_INV_CHAR_ANGLE_ATTR");
+            break;
+
+        case PMERR_INV_MARKER_SET_ATTR:
+            sError = wxT("PMERR_INV_MARKER_SET_ATTR");
+            break;
+
+        case PMERR_INV_MARKER_SYMBOL_ATTR:
+            sError = wxT("PMERR_INV_MARKER_SYMBOL_ATTR");
+            break;
+
+        case PMERR_INV_PATTERN_SET_ATTR:
+            sError = wxT("PMERR_INV_PATTERN_SET_ATTR");
+            break;
+
+        case PMERR_INV_PATTERN_ATTR:
+            sError = wxT("PMERR_INV_PATTERN_ATTR");
+            break;
+
+        case PMERR_INV_COORDINATE:
+            sError = wxT("PMERR_INV_COORDINATE");
+            break;
+
+        case PMERR_UNSUPPORTED_ATTR_VALUE:
+            sError = wxT("PMERR_UNSUPPORTED_ATTR_VALUE");
+            break;
+
+        case PMERR_INV_PATTERN_SET_FONT:
+            sError = wxT("PMERR_INV_PATTERN_SET_FONT");
+            break;
+
+        case PMERR_HUGE_FONTS_NOT_SUPPORTED:
+            sError = wxT("PMERR_HUGE_FONTS_NOT_SUPPORTED");
+            break;
+

         default:
             sError = wxT("Unknown error");
     }
         default:
             sError = wxT("Unknown error");
     }

-    return(sError);
+    return sError;

 } // end of wxPMErrorToStr
 } // end of wxPMErrorToStr

-
-// replacement for implementation in unix/utilsunx.cpp,
-// to be used by all X11 based ports.
-struct wxEndProcessData;
-
-void wxHandleProcessTermination(wxEndProcessData *WXUNUSED(proc_data))
-{
-    // For now, just do nothing. To be filled in as needed.
-}