fileUtils.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_FILE_UTILS_H
#define PXR_BASE_TF_FILE_UTILS_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"
 
#include <string>
#include <vector>
#include <functional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_API
bool TfPathExists(std::string const& path, bool resolveSymlinks = false);
 
TF_API
bool TfIsDir(std::string const& path, bool resolveSymlinks = false);
 
TF_API
bool TfIsFile(std::string const& path, bool resolveSymlinks = false);
 
TF_API
bool TfIsLink(std::string const& path);
 
TF_API
bool TfIsWritable(std::string const& path);
 
TF_API
bool TfIsDirEmpty(std::string const& path);
 
TF_API
bool TfSymlink(std::string const& src, std::string const& dst);
 
TF_API
bool TfDeleteFile(std::string const& path);
 
TF_API
bool TfMakeDir(std::string const& path, int mode=-1);
 
TF_API
bool TfMakeDirs(std::string const& path, int mode=-1, bool existOk=false);
 
typedef std::function<bool (std::string const&,
                            std::vector<std::string> *,
                            std::vector<std::string> const&)> TfWalkFunction;
 
typedef std::function<void (std::string const&,
                            std::string const&)> TfWalkErrorHandler;
 
TF_API
void TfWalkIgnoreErrorHandler(std::string const& path, std::string const& msg);
 
TF_API
void TfWalkDirs(std::string const& top,
                TfWalkFunction fn,
                bool topDown=true,
                TfWalkErrorHandler onError = 0,
                bool followLinks = false);
 
TF_API
void TfRmTree(std::string const& path,
              TfWalkErrorHandler onError = 0);
 
TF_API
std::vector<std::string> TfListDir(std::string const& path,
                                   bool recursive = false);
 
TF_API
bool
TfReadDir(std::string const &dirPath,
          std::vector<std::string> *dirnames,
          std::vector<std::string> *filenames,
          std::vector<std::string> *symlinknames,
          std::string *errMsg = NULL);
 
TF_API
bool TfTouchFile(std::string const &fileName, bool create=true);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_FILE_UTILS_H