misystem.h

Go to the documentation of this file.

/**
 * \file misystem.h <mi32/misystem.h>
 * \brief MISYSTEM class definition
 *
 * \if NODOC
 * $Id: misystem.h_v 1.16 2004/07/09 17:30:28 dwilliss Exp $
 *
 * $Log: misystem.h_v $
 * Revision 1.16  2004/07/09 17:30:28  dwilliss
 * Needed to forward declare FILEPATH
 *
 * Revision 1.15  2004/07/09 17:27:40  dwilliss
 * Added SetCurrentWorkingDirectory
 *
 * Revision 1.14  2004/04/13 17:23:34  mju
 * Change Win32_Old to Win32_PreNT.
 *
 * Revision 1.13  2004/04/13 16:49:41  dwilliss
 * Fixed platform enums so Win32_NT did not include the Win32_Old bit
 *
 * Revision 1.12  2003/12/22 21:01:06  dwilliss
 * Added static methods to get/set main app's HINSTANCE (Windows only)
 *
 * Revision 1.11  2003/10/09 13:37:20  mju
 * Add GetTimerValue.
 *
 * Revision 1.10  2003/10/08 14:53:17  mju
 * Add GetTicksPerSecond.
 *
 * Revision 1.9  2003/09/15 15:39:03  dwilliss
 * Mismatched #ifdef from doxygen cleanup
 *
 * Revision 1.8  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/07/09 13:59:56  mju
 * nc.
 *
 * Revision 1.6  2003/07/08 17:27:54  scowan
 * Undefine class lib export at the end of the module.
 *
 * Revision 1.5  2003/07/03 20:03:21  scowan
 * Moved get tick count to here.
 *
 * Revision 1.4  2003/07/03 16:36:12  scowan
 * Added translate system error method.
 *
 * Revision 1.3  2003/05/20 20:45:50  mju
 * Add methods to get total/available physical/virtual memory.
 *
 * Revision 1.2  2003/05/20 18:00:57  mju
 * Add PLATFORM enum and GetPlatform.
 * Add WindowsIsUnicode.
 * Add Supports64BitFileSystem.
 * Add Sleep.
 *
 * Revision 1.1  2003/05/19 15:38:11  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MI32_MISYSTEM_H
#define  INC_MI32_MISYSTEM_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif

class FILEPATH;

//! Container for static methods to access various system and execution environment valuses.
class CLASSLIBEXPORT MISYSTEM {
   public:

      enum PLATFORM {
         PLATFORM_Unknown =         0,

         PLATFORM_Win32_PreNT =     0x000100,
         PLATFORM_Win95 =           (PLATFORM_Win32_PreNT | 0x01),      //! Microsoft Windows 95
         PLATFORM_Win98 =           (PLATFORM_Win32_PreNT | 0x02),      //! Microsoft Windows 98
         PLATFORM_WinME =           (PLATFORM_Win32_PreNT | 0x03),      //! Microsoft Windows Me

         PLATFORM_Win32_NT =        0x001000,
         PLATFORM_WinNT =           (PLATFORM_Win32_NT | 0x01),      //! Microsoft Windows NT 4
         PLATFORM_Win2000 =         (PLATFORM_Win32_NT | 0x02),      //! Microsoft Windows 2000
         PLATFORM_WinXP =           (PLATFORM_Win32_NT | 0x03),      //! Microsoft Windows XP

         PLATFORM_Unix =            0x002000,
         PLATFORM_MacOSX =          (PLATFORM_Unix | 0x01),
         PLATFORM_LinuxX86 =        (PLATFORM_Unix | 0x02),
         PLATFORM_UnixSun =         (PLATFORM_Unix | 0x03),
         PLATFORM_UnixSGI =         (PLATFORM_Unix | 0x04),
         PLATFORM_UnixIBM =         (PLATFORM_Unix | 0x05),
         };

      //! Get current user name.
      //! @return MISTRING containing name, will be 'UnknownUser' if cannot determine name.
      static MISTRING GetCurrentUserName ();

      //! Get value of named environment variable.
      //! @return MISTRING containing value, will be empty if no matching environment variable.
      static MISTRING GetEnvironmentValue (
         const char *name                       //!< Environment variable name
         );

      //! Get amount of available physical memory.
      //! @return Number of bytes, -1 if unsupported, < -1 if error.
      static INT64 GetPhysicalMemoryAvailable ();

      //! Get amount of total physical memory.
      //! @return Number of bytes, -1 if unsupported, < -1 if error.
      static INT64 GetPhysicalMemoryTotal ();

      //! Get platform.
      static PLATFORM GetPlatform ();
      
      //! Returns a simple clock tick of unknown starting time. 
      static UINT32 GetTickCount ();

      //! Get number of clock ticks per second.
      static UINT32 GetTicksPerSecond ();

      //! Return 'timer' value.
      //! Precision of timer is system-dependent, ranging from 1ms and 100ns.
      //! @return Number of seconds from arbitrary starting time.
      static double GetTimerValue ();

      //! Get amount of available virtual memory.
      //! The return value may change if the OS supports dynamic page/swap file allocation.
      //! @return Number of bytes, -1 if unsupported, < -1 if error.
      static INT64 GetVirtualMemoryAvailable ();

      //! Get total amount of virtual memory.
      //! The return value may change if the OS supports dynamic page/swap file allocation.
      //! @return Number of bytes, -1 if unsupported, < -1 if error.
      static INT64 GetVirtualMemoryTotal ();

      //! Set the current working directory
      //! Note, to get the current working directory, construct a FILEPATH
      //! with FILEPATH::PATHTYPE_Current.
      static ERRVALUE SetCurrentWorkingDirectory (
         const FILEPATH& filepath
         );

      //! Delay for specified time.
      static void Sleep (
         double delay                           //!< Time to delay in seconds
         );

      //! Determine if system supports 64-bit filesystems.
      static bool Supports64BitFileSystem ();

      //! Translate OS error code to MicroImages error code
      //! Does NOT do a SetErrPosn() on the error code, that is up to the caller
      static ERRVALUE TranslateSystemError (
         ERRVALUE DftErrCode,             //!< Default error code to use if system error not specifically handled
         INT32& SystemError               //!< Operating sytem error RETURNED
         );

   #ifdef WIN32
      //! Determine if Windows supports Unicode (Windows only).
      //! This may be used to determine if the 'wide character' versions of APIs may be used.
      //! @return true if supported, false if not.
      static bool WindowsIsUnicode ();


      //! Get the HINSTANCE of the application (Windows only)
      //! Sorry, you'll have to cast the return value to an HINSTANCE.
      //! this include file does not define any Windows types, nor should it.
      static void* GetMainHINSTANCE();

      //! Set the HINSTANCE of the application (Windows only)
      static void SetMainHINSTANCE(void*);
   #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISYSTEM ();            //! Unimplemented
      #endif //!< GENERATING_DOXYGEN_OUTPUT
   };

#undef   CLASSLIBEXPORT

#endif   //!< INC_MI32_MISYSTEM_H

---