FileUtils.h

Go to the documentation of this file.

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
 *
 * This library is open source and may be redistributed and/or modified under
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * OpenSceneGraph Public License for more details.
*/

#ifndef OSGDB_FILEUTILS
#define OSGDB_FILEUTILS 1

#include <osgDB/Registry>

#include <vector>
#include <deque>
#include <string>
#include <stdio.h>

namespace osgDB {

extern OSGDB_EXPORT FILE* fopen(const char* filename, const char* mode);

extern OSGDB_EXPORT bool makeDirectory( const std::string &directoryPath );

extern OSGDB_EXPORT bool makeDirectoryForFile( const std::string &filePath );

extern OSGDB_EXPORT std::string getCurrentWorkingDirectory( void );

extern OSGDB_EXPORT bool setCurrentWorkingDirectory( const std::string &newCurrentWorkingDirectory );


extern OSGDB_EXPORT bool fileExists(const std::string& filename);

enum FileType
{
    FILE_NOT_FOUND,
    REGULAR_FILE,
    DIRECTORY
};

extern OSGDB_EXPORT FileType fileType(const std::string& filename);

extern OSGDB_EXPORT std::string findFileInPath(const std::string& filename, const FilePathList& filePath,CaseSensitivity caseSensitivity=CASE_SENSITIVE);

extern OSGDB_EXPORT std::string findFileInDirectory(const std::string& fileName,const std::string& dirName,CaseSensitivity caseSensitivity=CASE_SENSITIVE);

typedef std::vector<std::string> DirectoryContents;

extern OSGDB_EXPORT DirectoryContents getDirectoryContents(const std::string& dirName);

extern OSGDB_EXPORT DirectoryContents getSortedDirectoryContents(const std::string& dirName);

extern OSGDB_EXPORT DirectoryContents expandWildcardsInFilename(const std::string& filename);

namespace FileOpResult {
    enum Value
    {
        OK,                          
        SOURCE_EQUALS_DESTINATION,   
        BAD_ARGUMENT,
        SOURCE_MISSING,              
        SOURCE_NOT_OPENED,           
        DESTINATION_NOT_OPENED,      
        READ_ERROR,
        WRITE_ERROR
    };
}

extern OSGDB_EXPORT FileOpResult::Value copyFile(const std::string & source, const std::string & destination);



inline void setDataFilePathList(const FilePathList& filepath) { osgDB::Registry::instance()->setDataFilePathList(filepath); }

inline void setDataFilePathList(const std::string& paths) { osgDB::Registry::instance()->setDataFilePathList(paths); }

inline FilePathList& getDataFilePathList() { return osgDB::Registry::instance()->getDataFilePathList(); }

extern OSGDB_EXPORT std::string findDataFile(const std::string& filename,CaseSensitivity caseSensitivity=CASE_SENSITIVE);

extern OSGDB_EXPORT std::string findDataFile(const std::string& filename,const Options* options, CaseSensitivity caseSensitivity=CASE_SENSITIVE);

inline void setLibraryFilePathList(const FilePathList& filepaths) { osgDB::Registry::instance()->setLibraryFilePathList(filepaths); }

inline void setLibraryFilePathList(const std::string& paths) { osgDB::Registry::instance()->setLibraryFilePathList(paths); }

inline FilePathList& getLibraryFilePathList() { return osgDB::Registry::instance()->getLibraryFilePathList(); }

extern OSGDB_EXPORT std::string findLibraryFile(const std::string& filename,CaseSensitivity caseSensitivity=CASE_SENSITIVE);

extern OSGDB_EXPORT void convertStringPathIntoFilePathList(const std::string& paths,FilePathList& filepath);

extern OSGDB_EXPORT bool containsCurrentWorkingDirectoryReference(const FilePathList& paths);

extern OSGDB_EXPORT void appendPlatformSpecificLibraryFilePaths(FilePathList& filepath);
extern OSGDB_EXPORT void appendPlatformSpecificResourceFilePaths(FilePathList& filepath);

}        // namespace osgDB

#endif