SbFileHelper.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SBFILEHELPER_H
#define SBFILEHELPER_H
 
#ifndef _WIN32
#include <unistd.h>
#endif // _WIN32
 
#include <sys/types.h>
#include <sys/stat.h>
 
#ifdef _WIN32
#include <io.h>
#define F_OK 0
#define W_OK 2
#define R_OK 4
#define X_OK 0
#endif
 
#include <Inventor/SbString.h>
 
class  SbFileHelper
{
  // ----------------------- Public usage --------------------------------------
public:
#ifdef WIN32
  typedef struct __stat64 Stat;
#else
  typedef struct stat64 Stat;
#endif
 
  static FILE* open( const SbString& filename, const char* flags );
 
  static void close( FILE* fp );
 
  static
#if defined(_WIN32)
    unsigned __int64
#else
    unsigned long long
#endif
    getFileSize( const SbString& filename );
 
  enum FileAccess
  {
    EXISTENCE = F_OK,
    WRITE = W_OK,
    READ = R_OK,
    READ_WRITE = W_OK + R_OK,
    EXECUTE = X_OK
  };
 
  static SbBool isAccessible( const SbString& filename, FileAccess mode=READ );
 
  static SbString getExtension( const SbString& filename );
 
  static SbBool isUrl( const SbString& filename );
 
  static SbBool isFileSystemUrl( const SbString& filename );
 
  static SbString makeFileSystemURL( const SbString& filename );
 
  static SbString fileSystemURLToFilename(  const SbString& url );
 
  static SbString getBaseName( const SbString& fullFilePath );
 
  static SbString getDirName( const SbString& fullFilePath );
 
  static SbString toUnixPath( const SbString& path );
 
  static SbString toWindowsPath( const SbString& path );
 
  static SbString getTempDirectory();
 
  static SbString getTempFilename( const SbString& path, const SbString& prefix );
 
  static int createDirectory( const SbString& directory );
 
  static SbString getCurrentDirectory();
 
  static int setCurrentDirectory( const SbString& directory );
 
  static bool containsWindowsDrive( const SbString& path );
 
  static int removeFile( const SbString& fileName );
 
  static bool getStat(const SbString& filename, SbFileHelper::Stat& stat);
 
  static SbString cleanUpPath( const SbString& path );
 
  static SbString expandString( const SbString& string );
 
  static void listFiles(const SbString& path, const SbString& pattern, std::vector<SbString>& files);
 
private:
 
  static int findExtensionPos( const SbString & filename );
 
  static void setFileExtension( SbString & _filename, const SbString &_strExt );
 
  static SbString cleanupBadNetworkName( const SbString& string );
 
  static SbString getOivLocalAppDataPath();
 
  static SbString getOivLibrariesPath();
 
  static bool createSubDirectories(const SbString& path);
 
  static SbBool deleteFile(const SbString& file);
 
  // ----------------------- Protected usage --------------------------------------
 
private:
 
  // ----------------------- Private usage --------------------------------------
 
private:
 
};
 
// ----------------------- Inline functions --------------------------------------
 
//------------------------------------------------------------------------------
 
#endif // SBFILEHELPER_H