mlFileSystem.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_FILE_SYSTEM_H
#define ML_FILE_SYSTEM_H
 
 
#include "mlUtilsSystem.h"
#include <cstdio>
 
#include <ThirdPartyWarningsDisable.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <ThirdPartyWarningsRestore.h>
#include <string>
#include <filesystem>
 
 
#ifdef WIN32
 
  #define ML_O_APPEND    _O_APPEND
 
  #define ML_O_BINARY    _O_BINARY
 
  #define ML_O_CREAT     _O_CREAT
 
  #define ML_O_RANDOM    _O_RANDOM
 
  #define ML_O_RDONLY    _O_RDONLY
 
  #define ML_O_RDWR      _O_RDWR
 
  #define ML_O_TEXT      _O_TEXT
 
  #define ML_O_TRUNC     _O_TRUNC
 
  #define ML_O_WRONLY    _O_WRONLY
 
  #define ML_O_LARGEFILE 0
 
  #define ML_S_IWRITE    _S_IWRITE
 
  #define ML_S_IREAD     _S_IREAD
 
  #define ML_S_IEXEC     _S_IEXEC
 
  #define ML_S_IWUSR     ML_S_IWRITE
 
  #define ML_S_IRUSR     ML_S_IREAD
 
  #define ML_S_IXUSR     ML_S_IEXEC
 
  #define ML_S_IWGRP     ML_S_IWRITE
 
  #define ML_S_IRGRP     ML_S_IREAD
 
  #define ML_S_IXGRP     ML_S_IEXEC
 
  #define ML_S_IWOTH     ML_S_IWRITE
 
  #define ML_S_IROTH     ML_S_IREAD
 
  #define ML_S_IXOTH     ML_S_IEXEC
 
#else
 
  #define ML_O_APPEND    O_APPEND
 
  #define ML_O_BINARY    0
 
  #define ML_O_CREAT     O_CREAT
 
  #define ML_O_RANDOM    O_RANDOM
 
  #define ML_O_RDONLY    O_RDONLY
 
  #define ML_O_RDWR      O_RDWR
 
  #define ML_O_TEXT      0
 
  #define ML_O_TRUNC     O_TRUNC
 
  #define ML_O_WRONLY    O_WRONLY
 
  #if defined(MACOS)
    #define ML_O_LARGEFILE 0
  #else
    #define ML_O_LARGEFILE O_LARGEFILE
  #endif
 
  #define ML_S_IWRITE    S_IWRITE
 
  #define ML_S_IREAD     S_IREAD
 
  #define ML_S_IEXEC     S_IEXEC
 
  #define ML_S_IWUSR     S_IWUSR
 
  #define ML_S_IRUSR     S_IRUSR
 
  #define ML_S_IXUSR     S_IXUSR
 
  #define ML_S_IWGRP     S_IWGRP
 
  #define ML_S_IRGRP     S_IRGRP
 
  #define ML_S_IXGRP     S_IXGRP
 
  #define ML_S_IWOTH     S_IWOTH
 
  #define ML_S_IROTH     S_IROTH
 
  #define ML_S_IXOTH     S_IXOTH
 
#endif
 
 
ML_UTILS_EXPORT void        MLTranslateErrorCode(MLErrorCode *err);
 
 
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
 
[[nodiscard]]
ML_UTILS_EXPORT FILE* MLfopen(const char *fileName,
                              const char *mode);
 
ML_UTILS_EXPORT MLErrorCode MLfclose(FILE *file);
 
ML_UTILS_EXPORT MLErrorCode MLremove(const char *fileName);
 
ML_UTILS_EXPORT MLErrorCode MLrename(const char *oldName,
                                     const char *newName);
 
[[nodiscard]]
ML_UTILS_EXPORT int         MLopen(const char *fileName,
                                   int         openFlags,
                                   int         pMode);
 
ML_UTILS_EXPORT MLErrorCode MLclose(int fileDescriptor);
 
ML_UTILS_EXPORT int         MLFileExists(const char *fileName);
 
[[nodiscard]]
ML_UTILS_EXPORT char       *MLGetTempPath();
 
[[nodiscard]]
ML_UTILS_EXPORT char       *MLGetNonExistingRandomFileName(const char *prefix);
 
// Tag to identify whether MLGetNonExistingRandomFileNameWithPostFix exists to avoid
// failing mainline builds. To be removed after merge to trunk.
#define MLGetNonExistingRandomFileNameWithPostFix_Is_Available
 
[[nodiscard]]
ML_UTILS_EXPORT char       *MLGetNonExistingRandomFileNameWithPostFix(const char *prefix, const char *postFix);
 
ML_UTILS_EXPORT int         MLFileIsReadable(const char *fileName);
 
ML_UTILS_EXPORT int         MLFileIsWritable(const char *fileName);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileWriteStringData(const char *fileName,
                                                  const char *str);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileWriteBinaryData(const char    *fileName,
                                                  const MLuint8 *data,
                                                  size_t         numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileWriteBinaryDataAt(int            fileDescriptor,
                                                    MLuint         startPosition,
                                                    const MLuint8 *data,
                                                    size_t         numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileAppendStringData(const char *fileName,
                                                   const char *strData);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileAppendBinaryData(const char    *fileName,
                                                   const MLuint8 *data,
                                                   size_t         numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLFileAppendBinaryDataWithDescriptor(int            fileDescriptor,
                                                                 const MLuint8 *data,
                                                                 size_t         numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT char*       MLFileReadAllAsString(const char *fileName);
 
[[nodiscard]]
ML_UTILS_EXPORT MLuint8*    MLFileReadAllAsBinary(const char *fileName);
 
[[nodiscard]]
ML_UTILS_EXPORT char*       MLFileReadChunkAsString(const char *fileName,
                                                    MLuint      startPosition,
                                                    MLuint      numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT MLuint8*    MLFileReadChunkAsBinary(const char *fileName,
                                                    MLuint      startPosition,
                                                    MLuint      numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT MLuint8*    MLFileReadChunkAsBinaryFromDesc(int    fileDescriptor,
                                                            MLuint startPosition,
                                                            MLuint numBytes,
                                                            int    useCurrentPosition);
 
ML_UTILS_EXPORT MLuint MLFileReadChunkAsBinaryFromDescToBuffer(int    fileDescriptor,
  MLuint8* buffer,
  MLuint startPosition,
  MLuint numBytes);
 
[[nodiscard]]
ML_UTILS_EXPORT char*       MLFileReadChunkAsStringFromDesc(int    fileDescriptor,
                                                            MLuint startPosition,
                                                            MLuint numBytes);
 
 
ML_UTILS_EXPORT MLint       MLFileGetSizeFromDescriptor(int fileDescriptor);
 
ML_UTILS_EXPORT MLint MLFileGetSizeFromFilePointer(FILE *file);
 
ML_UTILS_EXPORT MLint       MLFileGetSizeFromName(const char* fileName);
 
[[nodiscard]]
ML_UTILS_EXPORT MLint       MLFileSetBytePos(int    fileDescriptor,
                                             MLuint position);
 
[[nodiscard]]
ML_UTILS_EXPORT MLint       MLFileGetBytePos(int fileDescriptor);
 
[[nodiscard]]
ML_UTILS_EXPORT MLErrorCode MLCreateDirectory(const char *path);
 
[[nodiscard]]
ML_UTILS_EXPORT std::filesystem::path MLGetFileSystemPath(const std::string& filename);
 
 
 
#endif // __mlFileSystem_H