System.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   System.h
//  AUTHOR      :   vovechkin
//  CREATION    :   2003-07-26
//  Copyright (C) MicroStrategy Incorporated 2003
//  All Rights Reserved
//==============================================================================================
#ifndef MBase_System_h
#define MBase_System_h

#include "Base.h"

#include "ReturnString.h"
#include "BaseString.h"

// 2003-07-26 vovechkin
// NOTE: this header file should not include system-dependent headers,
// such as "wtypes.h"

// 2004-06-30 vovechkin
// use the anonymous namespace for this function, 
// to ensure that on UNIX, each module references
// its own copy of this function.
namespace
{
    inline void MBase_DummyFunction()
    {
        return;
    }
}

namespace MBase
{
#ifndef NO_WCHAR_SUPPORT
    DLL_BASE_EXIM void OutputDebugString(const WCHAR* ipDebugString) throw();
#endif
    DLL_BASE_EXIM void OutputDebugString(const char* ipDebugString) throw();

    DLL_BASE_EXIM MBase::ReturnWString GetEnvironmentVariableOrNULL(const WCHAR* ipVariableName);

    DLL_BASE_EXIM MBase::ReturnWString ReadEnvironmentVariable(const WCHAR* ipVariableName);

    DLL_BASE_EXIM unsigned Int32 GetCurrentProcessID();

    
    DLL_BASE_EXIM ReturnWString GetComputerName();

    DLL_BASE_EXIM Int32 GetUniqueMachineID();

    DLL_BASE_EXIM const char* GetProcessLocale() throw();

    DLL_BASE_EXIM unsigned Int32 GetCurrentThreadID();

    DLL_BASE_EXIM void YieldToAnotherThread();

    DLL_BASE_EXIM void Sleep(unsigned long inMilliseconds);

    DLL_BASE_EXIM ReturnWString IPAddress2MachineName(const MBase::String& ipAddr) throw();


    DLL_BASE_EXIM ReturnWString MachineName2IPAddress(const MBase::String& ipMachineName) throw();


    DLL_BASE_EXIM unsigned short GetNumberOfSystemProcessors() throw();

    DLL_BASE_EXIM MBase::ReturnWString GetModuleFileNameByAddressWithinModule(const void* ipAddressWithinModule);

    inline MBase::ReturnWString GetThisModuleFileName()
    {
        // 2004-07-26 yuwen
        // some compilers (GNU C++) do not like a reinterpret_cast of a function pointer.
        return GetModuleFileNameByAddressWithinModule((const void*) (&MBase_DummyFunction));
    }

    DLL_BASE_EXIM MBase::ReturnWString GetCurrentLogin();

    DLL_BASE_EXIM unsigned Int32 GetPseudoRandomInt32(unsigned Int32 iMaxValue) throw();

    inline bool IsBigEndian()
    {
    // 10/13/2004 yuwen make it more robust. 
    // Note that HP on Itanium64 is big endian; NT on Itanium64 is little endian
#if defined(_BIG_ENDIAN) 
    return true;
#elif defined (_LITTLE_ENDIAN)
    return false;
#elif defined(WIN32) || defined(__i386) || defined(__x86_64)
    return false;
#elif defined(__sparc) || defined(_POWER)
    return true;
#else
#error Unknown Platform
#endif
    }

#ifndef WIN32

    DLL_BASE_EXIM MBase::ReturnWString UserIDToName(int iUserID);

    DLL_BASE_EXIM int UserNameToID(const WCHAR* ipUserName);

    DLL_BASE_EXIM MBase::ReturnWString GroupIDToName(int iGroupID);

    DLL_BASE_EXIM int GroupNameToID(const WCHAR* ipGroupName);
#endif // WIN32

    /*
            Will return the Virtual Bytes(Commited) of the Iserver
    */
    DLL_BASE_EXIM unsigned long int GetPrivateBytes();

    /*
        Will pause the Iserver process
    */
    DLL_BASE_EXIM void PauseCurrentProcess();

    //xfan. 12/05/07.   
#ifdef sun
#define SYSTEM_PAGE_SIZE 8192
#else
#define SYSTEM_PAGE_SIZE 4096
#endif
    // Get the system page size
    // return false in error condition
    DLL_BASE_EXIM bool GetSymPageSize(size_t *opPageSize);

    DLL_BASE_EXIM ReturnWString GetCurrentProcessName();
}


#endif // MBase_System_h