LLVM  10.0.0svn
FileUtilities.h
Go to the documentation of this file.
1 //===- llvm/Support/FileUtilities.h - File System Utilities -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines a family of utility functions which are useful for doing
10 // various things with files.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_SUPPORT_FILEUTILITIES_H
15 #define LLVM_SUPPORT_FILEUTILITIES_H
16 
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Support/Errc.h"
21 #include "llvm/Support/Path.h"
22 
23 namespace llvm {
24 
25  /// DiffFilesWithTolerance - Compare the two files specified, returning 0 if
26  /// the files match, 1 if they are different, and 2 if there is a file error.
27  /// This function allows you to specify an absolute and relative FP error that
28  /// is allowed to exist. If you specify a string to fill in for the error
29  /// option, it will set the string to an error message if an error occurs, or
30  /// if the files are different.
31  ///
32  int DiffFilesWithTolerance(StringRef FileA,
33  StringRef FileB,
34  double AbsTol, double RelTol,
35  std::string *Error = nullptr);
36 
37 
38  /// FileRemover - This class is a simple object meant to be stack allocated.
39  /// If an exception is thrown from a region, the object removes the filename
40  /// specified (if deleteIt is true).
41  ///
42  class FileRemover {
43  SmallString<128> Filename;
44  bool DeleteIt;
45  public:
46  FileRemover() : DeleteIt(false) {}
47 
48  explicit FileRemover(const Twine& filename, bool deleteIt = true)
49  : DeleteIt(deleteIt) {
50  filename.toVector(Filename);
51  }
52 
54  if (DeleteIt) {
55  // Ignore problems deleting the file.
56  sys::fs::remove(Filename);
57  }
58  }
59 
60  /// setFile - Give ownership of the file to the FileRemover so it will
61  /// be removed when the object is destroyed. If the FileRemover already
62  /// had ownership of a file, remove it first.
63  void setFile(const Twine& filename, bool deleteIt = true) {
64  if (DeleteIt) {
65  // Ignore problems deleting the file.
66  sys::fs::remove(Filename);
67  }
68 
69  Filename.clear();
70  filename.toVector(Filename);
71  DeleteIt = deleteIt;
72  }
73 
74  /// releaseFile - Take ownership of the file away from the FileRemover so it
75  /// will not be removed when the object is destroyed.
76  void releaseFile() { DeleteIt = false; }
77  };
78 
79  enum class atomic_write_error {
83  };
84 
85  class AtomicFileWriteError : public llvm::ErrorInfo<AtomicFileWriteError> {
86  public:
88 
89  void log(raw_ostream &OS) const override;
90 
92  static char ID;
93 
94  private:
95  // Users are not expected to use error_code.
96  std::error_code convertToErrorCode() const override {
98  }
99  };
100 
101  // atomic_write_error + whatever the Writer can return
102 
103  /// Creates a unique file with name according to the given \p TempPathModel,
104  /// writes content of \p Buffer to the file and renames it to \p FinalPath.
105  ///
106  /// \returns \c AtomicFileWriteError in case of error.
107  llvm::Error writeFileAtomically(StringRef TempPathModel, StringRef FinalPath,
108  StringRef Buffer);
109 
111  writeFileAtomically(StringRef TempPathModel, StringRef FinalPath,
113 } // End llvm namespace
114 
115 #endif
This class represents lattice values for constants.
Definition: AllocatorList.h:23
std::error_code remove(const Twine &path, bool IgnoreNonExisting=true)
Remove path.
FileRemover(const Twine &filename, bool deleteIt=true)
Definition: FileUtilities.h:48
void releaseFile()
releaseFile - Take ownership of the file away from the FileRemover so it will not be removed when the...
Definition: FileUtilities.h:76
const atomic_write_error Error
Definition: FileUtilities.h:91
FileRemover - This class is a simple object meant to be stack allocated.
Definition: FileUtilities.h:42
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
int DiffFilesWithTolerance(StringRef FileA, StringRef FileB, double AbsTol, double RelTol, std::string *Error=nullptr)
DiffFilesWithTolerance - Compare the two files specified, returning 0 if the files match...
void toVector(SmallVectorImpl< char > &Out) const
Append the concatenated string into the given SmallString or SmallVector.
Definition: Twine.cpp:32
void setFile(const Twine &filename, bool deleteIt=true)
setFile - Give ownership of the file to the FileRemover so it will be removed when the object is dest...
Definition: FileUtilities.h:63
AtomicFileWriteError(atomic_write_error Error)
Definition: FileUtilities.h:87
Base class for user error types.
Definition: Error.h:344
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:565
llvm::Error writeFileAtomically(StringRef TempPathModel, StringRef FinalPath, StringRef Buffer)
Creates a unique file with name according to the given TempPathModel, writes content of Buffer to the...
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
atomic_write_error
Definition: FileUtilities.h:79
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
print Print MemDeps of function
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:77