BeFileName.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 <string.h>
#include <stdlib.h>
#include "Bentley.h"
#include "WString.h"
#include "BeStringUtilities.h"

struct _FILETIME;

#ifndef MAX_PATH
    #define MAX_PATH 260
#endif

BEGIN_BENTLEY_NAMESPACE


#if defined (_WIN32) // Windows && WinRT
    static CharCP   const  DIR_SEPARATOR             = "\\";
    static char     const  DIR_SEPARATOR_CHAR        = '\\';
    static WCharCP  const  WCSDIR_SEPARATOR          = L"\\";
    static WChar    const  WCSDIR_SEPARATOR_CHAR     = L'\\';
    static char     const  ALT_DIR_SEPARATOR_CHAR    = '/';
    static WChar    const  WCSALT_DIR_SEPARATOR_CHAR = L'/';
    static WCharCP  const  WCSALT_DIR_SEPARATOR      = L"/";
    static CharCP   const  ALL_FILES_FILTER          = "*.*";
    static WCharCP  const  WCSALL_FILES_FILTER       = L"*.*";
    static WCharCP  const  WCSDLL_EXT                = L"dll";
    static WCharCP  const  WCSSTLIB_EXT              = L"lib";
#elif defined (__APPLE__) || defined (ANDROID)
    static CharCP   const  DIR_SEPARATOR             = "/";
    static char     const  DIR_SEPARATOR_CHAR        = '/';
    static WCharCP  const  WCSDIR_SEPARATOR          = L"/";
    static WChar    const  WCSDIR_SEPARATOR_CHAR     = L'/';
    static char     const  ALT_DIR_SEPARATOR_CHAR    = '\\';
    static WChar    const  WCSALT_DIR_SEPARATOR_CHAR = L'\\';
    static WCharCP  const  WCSALT_DIR_SEPARATOR      = L"\\";
    static CharCP   const  ALL_FILES_FILTER          = "*";
    static WCharCP  const  WCSALL_FILES_FILTER       = L"*";
    #if defined (__APPLE__)
        static WCharCP  const  WCSDLL_EXT            = L"dylib";
    #else
        static WCharCP  const  WCSDLL_EXT            = L"so";
    #endif
    static WCharCP  const  WCSSTLIB_EXT              = L"a";
#else
    #error unknown platform
#endif
static CharCP   const  PATH_SEPARATOR            = ";";
static char     const  PATH_SEPARATOR_CHAR       = ';';

static WCharCP  const  WCSPATH_SEPARATOR         = L";";
static WChar    const  WCSPATH_SEPARATOR_CHAR    = L';';

enum class BeFileNameStatus
    {
    Success                       = SUCCESS,
    IllegalName                   = 1,
    AlreadyExists                 = 2,
    CantCreate                    = 3,
    FileNotFound                  = 4,
    CantDeleteFile                = 5,
    AccessViolation               = 6,
    CantDeleteDir                 = 7,
    UnknownError                  = ERROR,
    };

enum class BeFileNameAccess
    {
    Exists    = 0,                                              
    Read      = 4,                                              
    Write     = 2,                                              
    ReadWrite = BeFileNameAccess::Read|BeFileNameAccess::Write, 
    };

/*=================================================================================**/
struct BeFileName : WString
{

public:


    BeFileName () {}

    explicit BeFileName (WCharCP name) {SetName(name);}

    BENTLEYDLL_EXPORT void SupplyDefaultNameParts (WCharCP defaultName);

    BENTLEYDLL_EXPORT void OverrideNameParts (WCharCP overrideName);

    enum FileNameParts {Device=1, Directory=2, Basename=4, Extension=8, DevAndDir=(Device|Directory), NameAndExt=(Basename|Extension), All=(DevAndDir|NameAndExt) };
    BENTLEYDLL_EXPORT BeFileName (FileNameParts mask, WCharCP fullName);

    BeFileName (WCharCP dev, WCharCP dir, WCharCP name, WCharCP ext) {BuildName (dev, dir, name, ext);}

    BeFileName (BeFileName const& from) {*this = from;}

    // BeFileName& operator=(BeFileName const& from) { *this = from; return *this;}

    void Clear() { clear(); }

    BENTLEYDLL_EXPORT void SetName (WCharCP name);
    void SetName (WStringCR name) { assign (name); }

    BENTLEYDLL_EXPORT void BuildName (WCharCP dev, WCharCP dir, WCharCP name, WCharCP ext);

    BENTLEYDLL_EXPORT static void BuildName (WStringR combinedPath, WCharCP dev, WCharCP dir, WCharCP name, WCharCP ext);

    BeFileNameR AppendToPath (BeFileNameCR additionComponent) {return AppendToPath (additionComponent.GetName());}

    BENTLEYDLL_EXPORT BeFileNameR AppendToPath (WCharCP additionComponent);

    BENTLEYDLL_EXPORT BeFileNameR AppendExtension (WCharCP extension);

    BENTLEYDLL_EXPORT static void AppendToPath (WStringR dir, WCharCP additionComponent);

    BENTLEYDLL_EXPORT static void AppendSeparator (WCharP dir);

    BENTLEYDLL_EXPORT static void AppendSeparator (WStringR dir);

    BENTLEYDLL_EXPORT void AppendSeparator ();

    void AppendString (WCharCP string) { append (string); }

    BENTLEYDLL_EXPORT static void StripSeparatorAtEnd (WStringR dir);

    BENTLEYDLL_EXPORT void StripSeparatorAtEnd ();

    BENTLEYDLL_EXPORT void RemoveQuotes ();

    void StripWhiteSpace () { Trim (); }


    // ! Abbreviate
    BENTLEYDLL_EXPORT void Abbreviate (size_t maxLength);




    BENTLEYDLL_EXPORT BeFileName (CharCP name, bool isUtf8);

    BENTLEYDLL_EXPORT BeFileName (CharCP name, BentleyCharEncoding encoding);

    explicit BeFileName (Utf8StringCR name) {SetNameUtf8(name);}

    void GetName (WCharP name, size_t size) const { wcsncpy (name, c_str(), size-1); name[size-1] = 0; }

    BENTLEYDLL_EXPORT void GetNameA (char name[MAX_PATH]) const;

    BENTLEYDLL_EXPORT void GetNameA (CharP name, size_t numBytes) const;

    BENTLEYDLL_EXPORT Utf8String GetNameUtf8 () const;

    BENTLEYDLL_EXPORT Utf8String GetUri () const;

    BENTLEYDLL_EXPORT void SetNameA (CharCP name);

    void SetNameUtf8 (Utf8StringCR name) {SetNameUtf8 (name.c_str ());}

    BENTLEYDLL_EXPORT void SetNameUtf8 (Utf8CP name);




    BENTLEYDLL_EXPORT static void ParseName (WStringP dev, WStringP dir, WStringP name, WStringP ext, WCharCP fullFileName);

    BENTLEYDLL_EXPORT static void ParseNameNoClear (WStringP dev, WStringP dir, WStringP name, WStringP ext, WCharCP fullFileName);

    void ParseName (WStringP dev, WStringP dir, WStringP name, WStringP ext) const {ParseName (dev, dir, name, ext, c_str());}

    void ParseNameNoClear (WStringP dev, WStringP dir, WStringP name, WStringP ext) const {ParseNameNoClear (dev, dir, name, ext, c_str());}


    BENTLEYDLL_EXPORT void PopDir();

    BENTLEYDLL_EXPORT static WString GetDirectoryName (WCharCP path);

    BENTLEYDLL_EXPORT static WString GetDirectoryWithoutDevice (WCharCP path);

    BENTLEYDLL_EXPORT static WString GetExtension (WCharCP path);

    static WString GetFileNameAndExtension (WCharCP path) {return WString(BeFileName(NameAndExt, path));}

    BENTLEYDLL_EXPORT static WString GetFileNameWithoutExtension (WCharCP path);

    BENTLEYDLL_EXPORT static WString GetDevice (WCharCP path);




    BENTLEYDLL_EXPORT static void FindRelativePath (WStringR relativePath, WCharCP targetFileName, WCharCP rootFileName);

    BENTLEYDLL_EXPORT static BentleyStatus ResolveRelativePath (WStringR fullPath, WCharCP relativeFileName, WCharCP basePath);

    BENTLEYDLL_EXPORT static BeFileNameStatus FixPathName (WStringR path, WCharCP original);

    BENTLEYDLL_EXPORT static BeFileNameStatus BeGetFullPathName (WStringR path, WCharCP src);

    BENTLEYDLL_EXPORT BeFileNameStatus BeGetFullPathName ();



    
    BENTLEYDLL_EXPORT static bool IsSymbolicLink(WCharCP);
        
    BENTLEYDLL_EXPORT static BentleyStatus GetTargetOfSymbolicLink(BeFileNameR, WCharCP);
    
    BENTLEYDLL_EXPORT static BentleyStatus GetTargetOfSymbolicLink(BeFileNameR, WCharCP, bool shouldRecurse);
    



    BENTLEYDLL_EXPORT static bool AreSameFile (WCharCP file1, WCharCP file2);

    BENTLEYDLL_EXPORT static bool DoesPathExist (WCharCP path);

    BENTLEYDLL_EXPORT bool IsAbsolutePath () const;

    BENTLEYDLL_EXPORT bool IsUrl() const;

    BENTLEYDLL_EXPORT static bool IsUrl(WCharCP filename);

    WCharCP GetName () const {return c_str();}

    operator WCharCP() const {return c_str();}

    bool IsEmpty () const { return empty(); }

    size_t GetNameSize () { return size(); }




    BENTLEYDLL_EXPORT static bool IsDirectory(WCharCP path);

    BENTLEYDLL_EXPORT static BeFileNameStatus CreateNewDirectory(WCharCP path);

    BENTLEYDLL_EXPORT static BeFileNameStatus RemoveDirectory (WCharCP path);

    BENTLEYDLL_EXPORT static BeFileNameStatus EmptyAndRemoveDirectory(WCharCP path);

    BENTLEYDLL_EXPORT static BeFileNameStatus CloneDirectory (WCharCP sourceDir, WCharCP destDir, bool includeSubDirs=true);




    BENTLEYDLL_EXPORT static BeFileNameStatus BeCopyFile (WCharCP existingFileName, WCharCP newFileName, bool failIfFileExists = false);

    BENTLEYDLL_EXPORT static BeFileNameStatus BeDeleteFile (WCharCP fileNameP, bool removeReadOnlyAttribute = false);

    BENTLEYDLL_EXPORT static BeFileNameStatus BeMoveFile (WCharCP oldFileName, WCharCP newFileName, int numRetries = 0);

    BENTLEYDLL_EXPORT static BeFileNameStatus SetFileReadOnly (WCharCP fileName, bool readOnly);

    BENTLEYDLL_EXPORT static BeFileNameStatus MoveToRecycleBin (WCharCP path);


    BENTLEYDLL_EXPORT static BeFileNameStatus GetFileSize (UInt64& sz, WCharCP fileName);

    BENTLEYDLL_EXPORT static BeFileNameStatus GetFileTime (::_FILETIME* ctime, ::_FILETIME* atime, ::_FILETIME* mtime, WCharCP fileName);

    BENTLEYDLL_EXPORT static BeFileNameStatus SetFileTime (WCharCP fileName, ::_FILETIME const* atime, ::_FILETIME const* mtime);

    BENTLEYDLL_EXPORT static BeFileNameStatus CheckAccess (WCharCP fileName, BeFileNameAccess accs);



    BENTLEYDLL_EXPORT static BeFileNameStatus BeGetDiskFreeSpace (UInt64& freeBytes, WCharCP dirName);

    BENTLEYDLL_EXPORT static bool IsRemovableMedia (WCharCP fn);

    BENTLEYDLL_EXPORT static BentleyStatus BeCompactPath (WStringR shortened, WCharCP path, UInt32 length);

    BENTLEYDLL_EXPORT static BeFileNameStatus BeGetTempFileName (BeFileName& tempFileName, BeFileName const& pathName, WCharCP prefixString);

    BENTLEYDLL_EXPORT static BeFileNameStatus BeGetTempPath (BeFileName& tempFileName);



};

BENTLEYDLL_EXPORT BentleyStatus   BeGetModuleFileName (BeFileName& filename, void* module);

BENTLEYDLL_EXPORT UInt32          BeGetCurrentProcessId ();

BENTLEYDLL_EXPORT WString         BeGetCwd ();



END_BENTLEY_NAMESPACE