BeFile.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once


#include "Bentley.h"
#include <assert.h>
#include "BeFileName.h"
#include "ByteStream.h"
#include <stdio.h>

#define CSS_UTF8    L", ccs=UTF-8"

struct _FILETIME;

BEGIN_BENTLEY_NAMESPACE


enum class BeFileStatus
    {
    Success                      = SUCCESS,  
    FileNotFoundError,                             
    AccessViolationError,                          
    SharingViolationError,                         
    TooManyOpenFilesError,                         
    FileNotOpenError,                              
    NotLockedError,                                
    ReadError,                                
    UnknownError                  = ERROR,    
    };

enum class BeFileAccess
    {
    Read  = 1,       
    Write = 2,       
    ReadWrite = 3,   
    };

enum class BeFileSharing
    {
    None = 0,         
    Read = 1,         
    Write = 2,        
    ReadWrite = 3,    
    };

enum class BeFileAttributes
    {
    Normal    = 0,       
    RandomIO  = 1,       
    DeleteOnClose = 2,   
    };

enum class BeFileSeekOrigin
    {
    Begin      = 0,    
    Current    = 1,    
    End        = 2,    
    };

/*=================================================================================**/
struct BeFile
{
private:
    void*                   m_handle;
    BeFileAccess            m_mode;
    BeFileSharing           m_sh;
    mutable BeFileStatus    m_lastError;

    BeFile (BeFile const&) {assert(false);}  // No!
    BeFile& operator=(BeFile const&) {assert(false); return *this;} // No!

public:
    BeFileStatus SetLastError () const;

public:
    BENTLEYDLL_EXPORT BeFile ();

    ~BeFile() {Close();}

    BENTLEYDLL_EXPORT void Swap (BeFile& other);

    BENTLEYDLL_EXPORT BeFileStatus Create (wchar_t const* filename, bool createAlways = true, BeFileAttributes attributes = BeFileAttributes::Normal);

    BENTLEYDLL_EXPORT BeFileStatus Open (wchar_t const* filename, BeFileAccess mode, BeFileSharing shareOptions, BeFileAttributes attributes = BeFileAttributes::Normal, int numRetries = 0);

    BENTLEYDLL_EXPORT static FILE* Fsopen (wchar_t const* filename, wchar_t const* mode, BeFileSharing shareOptions);

    BENTLEYDLL_EXPORT BeFileStatus Close();

    BENTLEYDLL_EXPORT bool IsOpen () const;

    BeFileAccess GetAccess() const {return m_mode;}

    BeFileSharing GetShareMode() const {return m_sh;}

    void* GetHandle() const {return (void*)(intptr_t)m_handle;}

    BeFileStatus GetLastError() const {return m_lastError;}

    BENTLEYDLL_EXPORT BeFileStatus SetPointer (UInt64 position, BeFileSeekOrigin origin);

    BENTLEYDLL_EXPORT BeFileStatus GetPointer (UInt64& position);

    BENTLEYDLL_EXPORT BeFileStatus Read (void* buffer, UInt32* bytesRead, UInt32 numBytes);

    BENTLEYDLL_EXPORT BeFileStatus Write (UInt32* bytesWritten, void const* buffer, UInt32 numBytes);

    BENTLEYDLL_EXPORT BeFileStatus Flush ();

    BENTLEYDLL_EXPORT BeFileStatus GetSize (UInt64& length) const;

    BENTLEYDLL_EXPORT BeFileStatus SetSize (UInt64 length);

    BENTLEYDLL_EXPORT static BeFileStatus SetSize (FILE* file, long length);

    BENTLEYDLL_EXPORT BeFileStatus ReadEntireFile(bvector<Byte>& buffer);

    BENTLEYDLL_EXPORT BeFileStatus ReadEntireFile(ByteStream& bytestream);


    BENTLEYDLL_EXPORT BeFileStatus GetTime (_FILETIME* ctime, _FILETIME* atime, _FILETIME* mtime) const;

    BENTLEYDLL_EXPORT BeFileStatus SetTime (_FILETIME const* ctime, _FILETIME const* atime, _FILETIME const* mtime);
};

BENTLEYDLL_EXPORT Long32 TranslateBeFileStatusToHresult (BeFileStatus status);

BENTLEYDLL_EXPORT BeFileStatus TranslateHResultToBeFileStatus (Long32 status);


END_BENTLEY_NAMESPACE