FGFS-4.1/OpenSceneGraph
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

To avoid noise in documentation replaced nested namespaced enum with enum with FILE_COPY_ wording prefixed into enum values.

Browse Source
This commit is contained in:
Robert Osfield
2016-11-15 08:57:24 +00:00
parent 80f75bcbdd
commit 87a3648e68
2 changed files with 21 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
include/osgDB/FileUtils
View File

@@ -84,26 +84,23 @@ extern OSGDB_EXPORT DirectoryContents getSortedDirectoryContents(const std::stri
* still work unchanged. */
extern OSGDB_EXPORT DirectoryContents expandWildcardsInFilename(const std::string& filename);
namespace FileOpResult {
enum Value
{
OK, /**< Operation done. */
SOURCE_EQUALS_DESTINATION, /**< Operation is useless (source == destination). */
BAD_ARGUMENT,
SOURCE_MISSING, /**< Source file doesn't exist. */
SOURCE_NOT_OPENED, /**< Error opening source file. */
DESTINATION_NOT_OPENED, /**< Error opening destination file. */
READ_ERROR,
WRITE_ERROR
};
}
enum CopyFileResult
{
COPY_FILE_OK, /**< Operation done. */
COPY_FILE_SOURCE_EQUALS_DESTINATION, /**< Operation is useless (source == destination). */
COPY_FILE_BAD_ARGUMENT,
COPY_FILE_SOURCE_MISSING, /**< Source file doesn't exist. */
COPY_FILE_SOURCE_NOT_OPENED, /**< Error opening source file. */
COPY_FILE_DESTINATION_NOT_OPENED, /**< Error opening destination file. */
COPY_FILE_READ_ERROR,
COPY_FILE_WRITE_ERROR
};
/** Copy a file to another location, overwriting if necessary.
* You must provide full path for both source and destination.
* \return true on success, or if source and destination are the same.
* \todo Replace the implementation with filesystem functions from TR2 when available.
*/
extern OSGDB_EXPORT FileOpResult::Value copyFile(const std::string & source, const std::string & destination);
extern OSGDB_EXPORT CopyFileResult copyFile(const std::string & source, const std::string & destination);