X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FSupport%2FFileUtilities.h;h=5456eb730a17118ce6a354af7bda61f9fa1e763e;hb=5eb301740c4ee5d978535caa917cc004733a7fca;hp=978b61bfd1775bf068047fbab7987e2daec3db38;hpb=9b448b703fbd60951a57e4d912bcbaf0181ed253;p=oota-llvm.git diff --git a/include/llvm/Support/FileUtilities.h b/include/llvm/Support/FileUtilities.h index 978b61bfd17..5456eb730a1 100644 --- a/include/llvm/Support/FileUtilities.h +++ b/include/llvm/Support/FileUtilities.h @@ -1,10 +1,10 @@ -//===- Support/FileUtilities.h - File System Utilities ----------*- C++ -*-===// -// +//===- llvm/Support/FileUtilities.h - File System Utilities -----*- C++ -*-===// +// // The LLVM Compiler Infrastructure // -// This file was developed by the LLVM research group and is distributed under -// the University of Illinois Open Source License. See LICENSE.TXT for details. -// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// //===----------------------------------------------------------------------===// // // This file defines a family of utility functions which are useful for doing @@ -12,117 +12,69 @@ // //===----------------------------------------------------------------------===// -#ifndef SUPPORT_FILEUTILITIES_H -#define SUPPORT_FILEUTILITIES_H +#ifndef LLVM_SUPPORT_FILEUTILITIES_H +#define LLVM_SUPPORT_FILEUTILITIES_H -#include +#include "llvm/Support/FileSystem.h" +#include "llvm/Support/Path.h" namespace llvm { -/// CheckMagic - Returns true IFF the file named FN begins with Magic. FN must -/// name a readable file. -/// -bool CheckMagic (const std::string &FN, const std::string &Magic); - -/// IsArchive - Returns true IFF the file named FN appears to be a "ar" library -/// archive. The file named FN must exist. -/// -bool IsArchive (const std::string &FN); - -/// IsBytecode - Returns true IFF the file named FN appears to be an LLVM -/// bytecode file. The file named FN must exist. -/// -bool IsBytecode (const std::string &FN); - -/// IsSharedObject - Returns trus IFF the file named FN appears to be a shared -/// object with an ELF header. The file named FN must exist. -/// -bool IsSharedObject(const std::string &FN); - -/// FileOpenable - Returns true IFF Filename names an existing regular file -/// which we can successfully open. -/// -bool FileOpenable (const std::string &Filename); - -/// DiffFiles - Compare the two files specified, returning true if they are -/// different or if there is a file error. 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, allowing the caller to distinguish between a failed diff and a file -/// system error. -/// -bool DiffFiles(const std::string &FileA, const std::string &FileB, - std::string *Error = 0); - - -/// MoveFileOverIfUpdated - If the file specified by New is different than Old, -/// or if Old does not exist, move the New file over the Old file. Otherwise, -/// remove the New file. -/// -void MoveFileOverIfUpdated(const std::string &New, const std::string &Old); - -/// removeFile - Delete the specified file -/// -void removeFile(const std::string &Filename); - -/// getUniqueFilename - Return a filename with the specified prefix. If the -/// file does not exist yet, return it, otherwise add a suffix to make it -/// unique. -/// -std::string getUniqueFilename(const std::string &FilenameBase); - -/// -/// Method: MakeFileExecutable() -/// -/// Description: -/// This method turns on whatever access attributes are needed to make the -/// specified file executable. -/// -/// Return value: -/// True - The operation succeeded. -/// False - The operation failed. -/// -/// Notes: -/// In case of failure, the file's access attributes are unspecified. -/// -bool MakeFileExecutable (const std::string & Filename); - -/// -/// Method: MakeFileReadable() -/// -/// Description: -/// This method turns on whatever access attributes are needed to make the -/// specified file readable. -/// -/// Return value: -/// True - The operation succeeded. -/// False - The operation failed. -/// -/// Notes: -/// In case of failure, the file's access attributes are unspecified. -/// -bool MakeFileReadable (const std::string & Filename); - - -/// FDHandle - Simple handle class to make sure a file descriptor gets closed -/// when the object is destroyed. -/// -class FDHandle { - int FD; - FDHandle(const FDHandle &); // DO NOT IMPLEMENT - void operator=(const FDHandle&); // DO NOT IMPLEMENT -public: - FDHandle() : FD(-1) {} - FDHandle(int fd) : FD(fd) {} - ~FDHandle() throw(); - - operator int() const { return FD; } - - FDHandle &operator=(int fd) throw(); - - /// take - Take ownership of the file descriptor away from the FDHandle - /// object, so that the file is not closed when the FDHandle is destroyed. - int take() throw(); -}; + /// 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(const sys::PathWithStatus &FileA, + const sys::PathWithStatus &FileB, + double AbsTol, double RelTol, + std::string *Error = 0); + + + /// 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. + bool existed; + sys::fs::remove(Filename.str(), existed); + } + } + + /// 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. + bool existed; + sys::fs::remove(Filename.str(), existed); + } + + 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