FileUtils.h

Go to the documentation of this file.

//-
// =============================================================================
// Copyright 2025 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// =============================================================================
//+
 
//
 
#ifndef BIFROST_FILE_UTILS_H
#define BIFROST_FILE_UTILS_H
 
#include "FileUtilsExport.h"
 
#include <Amino/Core/String.h>
#include <Amino/Core/StringView.h>
 
namespace Bifrost {
 
namespace FileUtils {
 
 
FILE_UTILS_DECL bool isAbsolute(Amino::StringView path);
 
FILE_UTILS_DECL bool createDirectories(Amino::StringView path,
                                       Amino::String*    errorMessage = nullptr);
 
FILE_UTILS_DECL bool currentPath(Amino::String& currentPath, Amino::String* errorMessage = nullptr);
 
FILE_UTILS_DECL Amino::String extractParentPath(Amino::StringView path);
 
FILE_UTILS_DECL Amino::String makePreferred(Amino::StringView path);
 
FILE_UTILS_DECL Amino::String filePath(Amino::StringView directory, Amino::StringView filename);
 
FILE_UTILS_DECL Amino::String filename(Amino::StringView baseName,
                                       long long         frame,
                                       Amino::StringView targetExtension);
 
FILE_UTILS_DECL Amino::String extractFilename(Amino::StringView filePath);
 
FILE_UTILS_DECL bool filePathExists(Amino::StringView filePath,
                                    Amino::String*    out_errorMessage = nullptr);
 
FILE_UTILS_DECL Amino::String getRelativePath(Amino::StringView path,
                                              Amino::StringView baseDirectory);
 
FILE_UTILS_DECL bool exists(Amino::StringView path, Amino::String* errorMessage = nullptr);
 
FILE_UTILS_DECL bool tempDirectoryPath(Amino::String& tempDirectoryPath,
                                       Amino::String* errorMessage = nullptr);
 
FILE_UTILS_DECL bool removeAll(Amino::StringView path, Amino::String* errorMessage = nullptr);
 
} // namespace FileUtils
} // namespace Bifrost
 
#endif // BIFROST_FILE_UTILS_H