RxSystemServices.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef _ODRXSYSTEMSERVICES_INCLUDED_
#define _ODRXSYSTEMSERVICES_INCLUDED_
 
#include <stdarg.h>
 
#include "RxObject.h"
#include "OdStreamBuf.h"
#include "OdCodePage.h"
#if defined(_DEBUG) && defined(_WIN32)
#define STL_USING_VECTOR
#include "OdaSTL.h"
#endif
 
class OdTimeStamp;
class OdRxModule;
class OdRxDictionary;
typedef OdSmartPtr<OdRxDictionary> OdRxDictionaryPtr;
 
#include "TD_PackPush.h"
 
namespace Oda
{
 
 
  enum FileAccessMode   // Access
  {
    kFileRead     = (long)
                    0x80000000,   // Read access. Use kFileRead | kFileWrite for read/write access.
    kFileWrite    = 0x40000000,   // Write access. Use kFileRead | kFileWrite for read/write access.
    kFileTmp      = 0x20000000,   // hint to use FILE_ATTRIBUTE_TEMPORARY  for 'FlagsAndAttributes'
    kFileDelete   = 0x10000000,   // hint to use FILE_FLAG_DELETE_ON_CLOSE for 'FlagsAndAttributes'
    kNoFlushWhenClosed = 0x08000000       //do NOT call FlushFileBuffers when closing file (tremendously accelerates writing small files)
  };
 
  enum FileShareMode
  {
    kShareDenyReadWrite = 0x10, // deny read/write mode
    kShareDenyWrite     = 0x20, // deny write mode
    kShareDenyRead      = 0x30, // deny read mode
    kShareDenyNo        = 0x40  // deny none mode
  };
 
 
  enum FileCreationDisposition
  {
    kCreateNew        = 1,  // Creates a new file; fails if the specified file already exists.
    kCreateAlways     = 2,  // Creates a new file; overwrites any existing file.
    kOpenExisting     = 3,  // Opens the file; fails if the file does not exist.
    kOpenAlways       = 4,  // Opens the file; creates the file if it does not exist.
    kTruncateExisting = 5   // Truncates the file; fails if the file does not exist. The file must be open at least kFileWrite.
  };
 
  enum UserNameFormat 
  {
    kUserId   = 1, //Current user id
    kUserName = 2  //A "friendly" user name (for example, Jeff Smith).
  };
}
 
class FIRSTDLL_EXPORT OdError_FileException : public OdError
{
public:
  OdError_FileException(OdResult code, const OdString& filename, const OdString& extended = OdString::kEmpty);
  OdString getFileName() const;
};
 
class FIRSTDLL_EXPORT OdError_FileNotFound : public OdError_FileException
{
public:
  OdError_FileNotFound(const OdString& filename);
};
 
class FIRSTDLL_EXPORT OdError_CantOpenFile : public OdError_FileException
{
public:
  OdError_CantOpenFile(const OdString& filename);
};
 
class FIRSTDLL_EXPORT OdError_FileWriteError : public OdError_FileException
{
public:
  OdError_FileWriteError(const OdString& filename);
};
 
class FIRSTDLL_EXPORT OdError_InvalidIndex : public OdError
{
public:
  OdError_InvalidIndex();
};
 
class FIRSTDLL_EXPORT OdError_InvalidKey: public OdError
{
public:
  OdError_InvalidKey();
};
 
class FIRSTDLL_EXPORT OdRxSystemServices : public OdRxObject
{
public:
 
  OdRxSystemServices()
  {
#if defined _WIN32_WCE
    srand(GetTickCount());
#else
    Od_srand((unsigned int) time(0));
#endif
  }
 
  virtual OdStreamBufPtr createFile(
    const OdString& filename,                    
    Oda::FileAccessMode accessMode = Oda::kFileRead,
    Oda::FileShareMode  shareMode = Oda::kShareDenyNo,                          
    Oda::FileCreationDisposition creationDisposition = Oda::kOpenExisting);
 
  virtual bool accessFile(const OdString& filename, int accessMode);
 
  virtual OdInt64 getFileCTime(const OdString& filename) = 0;
 
  virtual OdInt64 getFileMTime(const OdString& filename) = 0;
 
  virtual OdInt64 getFileSize(const OdString& filename) = 0;
 
 
  virtual OdString formatMessage(unsigned int formatId, va_list* argList= 0) = 0;
 
  virtual OdString formatMsg(unsigned int formatId, ...);
 
  virtual OdCodePageId systemCodePage() const = 0;
  
  virtual OdString createGuid();
 
  virtual OdGUID createOdGUID();
 
  virtual OdRxModule* loadModule(const OdString& moduleFileName, bool silent);
 
  virtual void unloadModule(OdRxModule* pModuleObj);
 
  virtual OdString findModule(const OdString& applicationName);
 
  virtual void warning(const OdString& message);
  
  virtual void warning(const char* warnVisGroup, const OdString& message);
 
  static OdRxModule* loadModuleLib(const OdString& moduleFileName, bool silent);
 
  virtual OdResult initModelerLibrary(OdRxDictionary *pDict);
  virtual OdResult uninitModelerLibrary(OdRxDictionary *pDict);
 
  virtual OdResult getEnvVar(const OdString &varName, OdString &value) = 0;
 
  virtual OdResult setEnvVar(const OdString &varName, const OdString &newValue) = 0;
 
  virtual OdString getTemporaryPath() const;
  
  virtual OdString getUserName(Oda::UserNameFormat unFormat = Oda::kUserId);
 
  virtual OdString getTempFileName();
 
#if defined(_DEBUG) && defined(_WIN32)
  static void dontFreeLibrary(std::vector<HMODULE>* notFreedDlls) { s_notFreedDlls = notFreedDlls; }
private:
  FIRSTDLL_EXPORT_STATIC static std::vector<HMODULE>* s_notFreedDlls;
#endif
};
typedef OdSmartPtr<OdRxSystemServices> OdRxSystemServicesPtr;
 
FIRSTDLL_EXPORT OdRxSystemServices* odrxSystemServices();
 
#include "TD_PackPop.h"
 
#endif // #ifndef _ODRXSYSTEMSERVICES_INCLUDED_