1 //===- Support/FileUtilities.h - File System Utilities ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines a family of utility functions which are useful for doing
11 // various things with files.
13 //===----------------------------------------------------------------------===//
15 #ifndef SUPPORT_FILEUTILITIES_H
16 #define SUPPORT_FILEUTILITIES_H
22 /// CheckMagic - Returns true IFF the file named FN begins with Magic. FN must
23 /// name a readable file.
25 bool CheckMagic (const std::string &FN, const std::string &Magic);
27 /// IsArchive - Returns true IFF the file named FN appears to be a "ar" library
28 /// archive. The file named FN must exist.
30 bool IsArchive (const std::string &FN);
32 /// IsBytecode - Returns true IFF the file named FN appears to be an LLVM
33 /// bytecode file. The file named FN must exist.
35 bool IsBytecode (const std::string &FN);
37 /// IsSharedObject - Returns trus IFF the file named FN appears to be a shared
38 /// object with an ELF header. The file named FN must exist.
40 bool IsSharedObject(const std::string &FN);
42 /// FileOpenable - Returns true IFF Filename names an existing regular file
43 /// which we can successfully open.
45 bool FileOpenable (const std::string &Filename);
47 /// DiffFiles - Compare the two files specified, returning true if they are
48 /// different or if there is a file error. If you specify a string to fill in
49 /// for the error option, it will set the string to an error message if an error
50 /// occurs, allowing the caller to distinguish between a failed diff and a file
53 bool DiffFiles(const std::string &FileA, const std::string &FileB,
54 std::string *Error = 0);
57 /// MoveFileOverIfUpdated - If the file specified by New is different than Old,
58 /// or if Old does not exist, move the New file over the Old file. Otherwise,
59 /// remove the New file.
61 void MoveFileOverIfUpdated(const std::string &New, const std::string &Old);
63 /// removeFile - Delete the specified file
65 void removeFile(const std::string &Filename);
67 /// getUniqueFilename - Return a filename with the specified prefix. If the
68 /// file does not exist yet, return it, otherwise add a suffix to make it
71 std::string getUniqueFilename(const std::string &FilenameBase);
74 /// Method: MakeFileExecutable()
77 /// This method turns on whatever access attributes are needed to make the
78 /// specified file executable.
81 /// True - The operation succeeded.
82 /// False - The operation failed.
85 /// In case of failure, the file's access attributes are unspecified.
87 bool MakeFileExecutable (const std::string & Filename);
90 /// Method: MakeFileReadable()
93 /// This method turns on whatever access attributes are needed to make the
94 /// specified file readable.
97 /// True - The operation succeeded.
98 /// False - The operation failed.
101 /// In case of failure, the file's access attributes are unspecified.
103 bool MakeFileReadable (const std::string & Filename);
106 /// FDHandle - Simple handle class to make sure a file descriptor gets closed
107 /// when the object is destroyed.
111 FDHandle(const FDHandle &); // DO NOT IMPLEMENT
112 void operator=(const FDHandle&); // DO NOT IMPLEMENT
114 FDHandle() : FD(-1) {}
115 FDHandle(int fd) : FD(fd) {}
118 operator int() const { return FD; }
120 FDHandle &operator=(int fd) throw();
122 /// take - Take ownership of the file descriptor away from the FDHandle
123 /// object, so that the file is not closed when the FDHandle is destroyed.
126 } // End llvm namespace