Path.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   Path.h
//  AUTHOR      :   vovechkin
//  CREATION    :   2002-08-27
//  Copyright (C) MicroStrategy Incorporated 2002
//  All Rights Reserved
//==============================================================================================
#ifndef MFileSystem_Path_h
#define MFileSystem_Path_h

#include "FileSystem.h"

//Yuqiang Huang - 01/13/2010 - TQMS 447466, 448037
//To make consistent with GUI (Web/MSTRDesk), make file name length limit to 250
const int FILE_NAME_LENGTH_LIMIT = 250;
const int FILE_EXTENSION_LENGTH_LIMIT = 4; //Based common practice
//Though different platforms have different limit, we simply choose the common mininum.
const int COMPLETE_FILE_NAME_LENGTH_LIMIT = 255;

#if defined(WIN32)
    const int COMPLETE_FILE_PATH_LENGTH_LIMIT = 255;
#else
    const int COMPLETE_FILE_PATH_LENGTH_LIMIT = 2147483647;  //INT_MAX - Maximum value for a variable of type int.
#endif

//Yuqiang Huang - 09/27/2010
//i-Server runs on Unix and saves files to Windows file sever
typedef enum
{
    DssNCSFileDestWindows   = 0,
    DssNCSFileDestUnix      = 1
} EnumFileDestPlatforms;

namespace MDataType
{
    class StringCollection;
}

namespace MFileSystem
{
    class DLL_FILE_SYSTEM_EXIM Path
    {
    public:

        static bool IsAbsolute( const char* ipPath );

        static MBase::ReturnString ToAbsolute(const char* ipPath);

        static bool IsDirectory( const char* ipPath );

        static bool IsFile( const char* ipPath );

        static bool IsReadable( const char* ipPath );

        static bool IsWriteable( const char* ipPath );


        //static bool AreExistingFoldersWriteable( const char* ipPath );

        static MBase::ReturnString GetParent( const char* ipPath );

        static MBase::ReturnString Internalize(const char* ipPath);

        static MBase::ReturnString Combine( const char* ipBasePath, const char* ipPath );

        static MBase::ReturnString GetDirname( const char* ipPath );

        static MBase::ReturnString GetBasename( const char* ipPathFileName );

        static MBase::ReturnString GetExtension(const char* ipFileName);

        static MBase::ReturnString GetBasenameWithoutExtension(const char* ipFileName);

        static MDataType::StringCollection* GetFileNamesWithPattern( const char* ipPathPattern );

        //Yuqiang Huang - 09/27/2010
        //i-Server runs on Unix and saves files to Windows file sever
        static bool IsAbsoluteCrossPlatform( const char* ipPath, EnumFileDestPlatforms iFileDestPlatform );
        static MBase::ReturnString CombineCrossPlatform( const char* ipBasePath, const char* ipPath, EnumFileDestPlatforms iFileDestPlatform );
    };
}

#endif // MFileSystem_Path_h