F:/My Projects/LSEngine/Modules/LSFileLib/Src/LSFFileLib.h

#ifndef __LSF_FILELIB_H__
#define __LSF_FILELIB_H__

// Include the memory library.
#include "LSAMemLib.h"
using namespace ::lsa;

// Include the threading library.
#include "LSHThreadLib.h"
using namespace ::lsh;

// Include the standard library.
#include "LSSTDStandardLib.h"
using namespace ::lsstd;

// Include the LSTL.
#include "LSTLib.h"
using namespace ::lstl;


#if defined( LSE_WINDOWS )
#include "Windows/LSSTDWindows.h"

// Max file path.
#define LSF_MAX_PATH                                            MAX_PATH

#elif defined( LSE_MAC )        // Macintosh uses standard C fopen() and etc.
#include <CoreFoundation/CoreFoundation.h>                      

// Max file path.
#define LSF_MAX_PATH                                            PATH_MAX

#endif  // #if defined( LSE_WINDOWS )


// TODO: Learn and add the headers for other systems.


namespace lsf {

        // == Enumerations.
        enum LSF_OPEN_FILE {
#ifdef LSE_WINDOWS
                LSF_OF_READ                                                     = FILE_READ_DATA,
                LSF_OF_WRITE                                            = FILE_WRITE_DATA,
                LSF_OF_APPEND                                           = FILE_APPEND_DATA,
#elif defined( LSE_MAC )
                LSF_OF_READ                                                     = (1 << 0),
                LSF_OF_WRITE                                            = (1 << 1),
                LSF_OF_APPEND                                           = (1 << 2),
#endif  // LSE_WINDOWS
        };


        // == Types.
#ifdef LSE_WINDOWS
        // A few namespace-specific types.
        typedef HANDLE                                                  LSF_FILE;

        enum LSF_SEEK {
                LSF_S_BEGIN                                                     = FILE_BEGIN,
                LSF_S_CURRENT                                           = FILE_CURRENT,
                LSF_S_END                                                       = FILE_END
        };

        typedef struct LSF_FILE_MAP {
                // Handle for the open file.
                HANDLE                                                          hFile;

                // Handle for the file map.
                HANDLE                                                          hFileMap;

                // Mapping mode.
                LSUINT32                                                        ui32Mode;

        } * LPLSF_FILE_MAP, * const LPCLSF_FILE_MAP;
#elif defined( LSE_MAC )
        typedef FILE *                                                  LSF_FILE;

        enum LSF_SEEK {
                LSF_S_BEGIN                                                     = SEEK_SET,
                LSF_S_CURRENT                                           = SEEK_CUR,
                LSF_S_END                                                       = SEEK_END
        };

        typedef struct LSF_FILE_MAP {
                // Handle for the open file and later close.
                int                                                                     iFile;

                // Mapping mode.
                LSUINT32                                                        ui32Mode;
        } * LPLSF_FILE_MAP, * const LPCLSF_FILE_MAP;
#endif  // LSE_WINDOWS



        class CFileLib {
        public :

                // == Functions.
                static LSF_FILE LSE_CALL                        OpenFile( const LSCHAR * _pcFile, LSF_OPEN_FILE _ofOpenType, LSBOOL _bOpenAlways );

                static LSBOOL LSE_CALL                          CloseFile( LSF_FILE &_fFile );

                static LSBOOL LSE_CALL                          ReadFile( LSF_FILE _fFile, LSVOID * _pvBuffer, LSUINTPTR _uiptrBytesToRead );

                static LSBOOL LSE_CALL                          WriteFile( LSF_FILE _fFile, const LSVOID * _pvBuffer, LSUINTPTR _uiptrBytesToWrite );

                static LSBOOL LSE_CALL                          SetFilePointer( LSF_FILE _fFile, LSINT64 _i64DistanceToMove, LSF_SEEK _sMoveMethod );

                static LSUINT64 LSE_CALL                        GetFilePointer( LSF_FILE _fFile );

                static LSBOOL LSE_CALL                          CreateFileMap( const LSCHAR * _pcFile, LSF_OPEN_FILE _ofOpenType,
                        LSF_FILE_MAP &_fmMap );

                static LSBOOL LSE_CALL                          CreateFileMap( const LSWCHAR_T * _pwcFile, LSF_OPEN_FILE _ofOpenType,
                        LSF_FILE_MAP &_fmMap );

                static LSVOID LSE_CALL                          DestroyFileMap( LSF_FILE_MAP &_fmMap );

                static LSVOID * LSE_CALL                        Map( const LSF_FILE_MAP &_fmMap, LSUINT64 _ui64Offset,
                        LSUINTPTR _uiptrLen );

                static LSVOID LSE_CALL                          UnMap( const LSVOID * _pvAddr, LSUINTPTR _uiptrLen );

                static LSBOOL LSE_CALL                          CanWriteToFileMap( const LSF_FILE_MAP &_fmMap );

                static LSUINT32 LSE_CALL                        GetPageSize();

                static LSUINT64 LSE_CALL                        GetFileSize( LSF_FILE _fFile );

                static LSUINT64 LSE_CALL                        GetFileSize( const LSCHAR * _pcFile );

                static LSUINT64 LSE_CALL                        GetFileSize( const LSWCHAR_T * _pwcFile );

                static LSBOOL LSE_CALL                          Exists( const LSCHAR * _pcFile );

                static LSBOOL LSE_CALL                          Exists( const LSWCHAR_T * _pwcFile );

                static LSCHAR * LSE_CALL                        GetSelfDir( LSCHAR * _pcRet );

                static LSWCHAR_T * LSE_CALL                     GetSelfDir( LSWCHAR_T * _pwcRet );

                static LSCHAR * LSE_CALL                        ExpandPath( const LSCHAR * _pcPath, LSCHAR * _pcRet );

                static LSWCHAR_T * LSE_CALL                     ExpandPath( const LSWCHAR_T * _pwcPath, LSWCHAR_T * _pwcRet );

                static LSCHAR * LSE_CALL                        ExpandResourcePath( const LSCHAR * _pcPath, LSCHAR * _pcRet );

                static LSCHAR * LSE_CALL                        NoExtension( LSCHAR * _pcPath );

                static LSWCHAR_T * LSE_CALL                     NoExtension( LSWCHAR_T * _pwcPath );

                static LSCHAR * LSE_CALL                        NoPath( LSCHAR * _pcPath );

                static LSWCHAR_T * LSE_CALL                     NoPath( LSWCHAR_T * _pwcPath );

                static LSCHAR * LSE_CALL                        NoFile( LSCHAR * _pcPath );

                static LSWCHAR_T * LSE_CALL                     NoFile( LSWCHAR_T * _pwcPath );

                static LSINT32 LSE_CALL                         Eof();

                static LSVOID LSE_CALL                          SetResPath( const LSCHAR * _pcPath );

                static LSE_INLINE const LSCHAR * LSE_CALL
                                                                                        GetResPath();


        protected :
                static LSCHAR                                           m_szResourcePath[LSF_MAX_PATH];

                static LSUINT32                                         m_ui32ResPathLen;
        };

        // == Functions.
        LSE_INLINE const LSCHAR * LSE_CALL CFileLib::GetResPath() {
                return m_szResourcePath;
        }

}       // namespace lsf

#endif  // __LSF_FILELIB_H__