diff options
Diffstat (limited to 'contrib/llvm-project/llvm/include/llvm/Support/FileUtilities.h')
-rw-r--r-- | contrib/llvm-project/llvm/include/llvm/Support/FileUtilities.h | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/contrib/llvm-project/llvm/include/llvm/Support/FileUtilities.h b/contrib/llvm-project/llvm/include/llvm/Support/FileUtilities.h new file mode 100644 index 000000000000..16b2206924c3 --- /dev/null +++ b/contrib/llvm-project/llvm/include/llvm/Support/FileUtilities.h @@ -0,0 +1,77 @@ +//===- llvm/Support/FileUtilities.h - File System Utilities -----*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// +// +// This file defines a family of utility functions which are useful for doing +// various things with files. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_SUPPORT_FILEUTILITIES_H +#define LLVM_SUPPORT_FILEUTILITIES_H + +#include "llvm/Support/FileSystem.h" +#include "llvm/Support/Path.h" + +namespace llvm { + + /// DiffFilesWithTolerance - Compare the two files specified, returning 0 if + /// the files match, 1 if they are different, and 2 if there is a file error. + /// This function allows you to specify an absolute and relative FP error that + /// is allowed to exist. If you specify a string to fill in for the error + /// option, it will set the string to an error message if an error occurs, or + /// if the files are different. + /// + int DiffFilesWithTolerance(StringRef FileA, + StringRef FileB, + double AbsTol, double RelTol, + std::string *Error = nullptr); + + + /// FileRemover - This class is a simple object meant to be stack allocated. + /// If an exception is thrown from a region, the object removes the filename + /// specified (if deleteIt is true). + /// + class FileRemover { + SmallString<128> Filename; + bool DeleteIt; + public: + FileRemover() : DeleteIt(false) {} + + explicit FileRemover(const Twine& filename, bool deleteIt = true) + : DeleteIt(deleteIt) { + filename.toVector(Filename); + } + + ~FileRemover() { + if (DeleteIt) { + // Ignore problems deleting the file. + sys::fs::remove(Filename); + } + } + + /// setFile - Give ownership of the file to the FileRemover so it will + /// be removed when the object is destroyed. If the FileRemover already + /// had ownership of a file, remove it first. + void setFile(const Twine& filename, bool deleteIt = true) { + if (DeleteIt) { + // Ignore problems deleting the file. + sys::fs::remove(Filename); + } + + Filename.clear(); + filename.toVector(Filename); + DeleteIt = deleteIt; + } + + /// releaseFile - Take ownership of the file away from the FileRemover so it + /// will not be removed when the object is destroyed. + void releaseFile() { DeleteIt = false; } + }; +} // End llvm namespace + +#endif |