File.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   File.h
//  AUTHOR      :   vovechkin
//  CREATION    :   2001-11-28
//  Copyright (C) MicroStrategy Incorporated 2001
//  All Rights Reserved
//==============================================================================================
#ifndef MFileSystem_File_h
#define MFileSystem_File_h

#include <stdio.h>
#include <string.h>

#include "FileSystem.h"

namespace MDataType
{
    // forward declarations
    class DateTime;
    class Binary;
}

namespace MFileSystem
{
    class DLL_FILE_SYSTEM_EXIM File
    {
    public:

        static void Move( const char* ipPathFrom, const char* ipPathTo );

        static bool Delete(const char* ipPath);

        static void Copy(const char* ipPathFrom, const char* ipPathTo, MDataType::Binary& irBinary);

        static void Copy(const char* ipPathFrom, const char* ipPathTo);

        static bool CopyAttributes(const char* ipPathFrom, const char* ipPathTo);

        static off_t GetSize( const char* ipPath );

        static void GetLastModified(const char* ipPath, MDataType::DateTime& orDateTime);



        enum OpenMode
        {
            OPEN_MODE_READ,                // "r"  --> read
            OPEN_MODE_WRITE_FROM_SCRATCH,  // "w"  --> write/create/truncate
            OPEN_MODE_WRITE_APPEND,        // "a"  --> write/create/append
            OPEN_MODE_UPDATE_EXISTING,     // "r+" --> read/write
            OPEN_MODE_UPDATE_FROM_SCRATCH, // "w+" --> read/write/create/truncate
            OPEN_MODE_UPDATE_APPEND,       // "a+" --> read/write/create/append
            OPEN_MODE_WRITE                // write/create/NO truncate, This is added for OpenDescriptor
        };

        enum ShareMode
        {
            SHARE_MODE_DEFAULT,        // default sharing
            SHARE_MODE_NONE,           // no sharing at all
            SHARE_MODE_READ,           // other processes can read this file
            SHARE_MODE_READ_AND_WRITE  // other processes can read/write this file
        };

    /*  static int OpenDescriptor(
            const char *ipPath,
            OpenMode iOpenMode,
            ShareMode iShareMode = SHARE_MODE_DEFAULT);
*/
        static FILE* OpenStream(
            const char* ipPath,
            OpenMode iOpenMode,
            ShareMode iShareMode = SHARE_MODE_DEFAULT);


        static void Copy(int iDescriptorFrom, int iDescriptorTo, MDataType::Binary& irBinary);
        static void Copy(FILE* ipStreamFrom, FILE* ipStreamTo, MDataType::Binary& irBinary);

        static void Copy(int iDescriptorFrom, const char* ipPathTo);

        static void Copy(FILE* ipStreamFrom, const char* ipPathTo);

        static off_t GetSize(int inDescriptor);
        static off_t GetSize(FILE* ipStream);

        static void Write( FILE* ipStream, const char* ipString, size_t iLength = 0 );

        static void Write( FILE* ipStream, const void* ipData, size_t iByteLength );

        static void Read(FILE* ipStream, MDataType::Binary& irBinary, size_t iMaxSize = 0);

        static void ReadLine(FILE* ipStream, MDataType::Binary& irBinary);

        static void Flush(int iDescriptor);
        static void Flush(FILE* ipStream);

        static void Truncate(int iDescriptor, off_t iSize = 0);
        static void Truncate(FILE* ipStream, off_t iSize = 0);

        static off_t GetPosition(int iDescriptor);
        static off_t GetPosition(FILE* ipStream);

        static void MovePosition(int iDescriptor, off_t iOffset);

        static void MovePosition(FILE* ipStream, off_t iOffset);

        static void SetPosition(int iDescriptor, off_t iOffset);

        static void SetPosition(FILE* ipStream, off_t iOffset);

        static void CopyBlock(FILE* ipStream, MDataType::Binary& irBinary, off_t iTo, off_t iSize = 0);

        class DLL_FILE_SYSTEM_EXIM WriteSmartLock
        {
        public:
            WriteSmartLock( int iDescriptor );
            WriteSmartLock(FILE* ipStream);
            ~WriteSmartLock() throw();

            void Lock();
            void Unlock() throw();

        private:
            const int mDescriptor;
            bool mIsLocked;
        };  

        class DLL_FILE_SYSTEM_EXIM ReadSmartLock
        {
        public:
            ReadSmartLock( int iDescriptor );
            ReadSmartLock(FILE* ipStream);
            ~ReadSmartLock() throw();

            void Lock();
            void Unlock() throw();

        private:
            const int mDescriptor;
            bool mIsLocked;
        };

    protected:
        friend class WriteSmartLock;
        friend class ReadSmartLock;

        friend class ReadableFileImpl;
        friend class WriteableFileImpl;

        static void WriteLock(int iDescriptor, bool bIsWait = true);
        static void ReadLock(int iDescriptor, bool bIsWait = true);
        static void Unlock( int iDescriptor ) throw();
    };
}

#endif // MFileSystem_File_h