summaryrefslogtreecommitdiff
path: root/clang-r353983e/include/llvm/Support/ToolOutputFile.h
diff options
context:
space:
mode:
Diffstat (limited to 'clang-r353983e/include/llvm/Support/ToolOutputFile.h')
-rw-r--r--clang-r353983e/include/llvm/Support/ToolOutputFile.h62
1 files changed, 62 insertions, 0 deletions
diff --git a/clang-r353983e/include/llvm/Support/ToolOutputFile.h b/clang-r353983e/include/llvm/Support/ToolOutputFile.h
new file mode 100644
index 00000000..a99e327f
--- /dev/null
+++ b/clang-r353983e/include/llvm/Support/ToolOutputFile.h
@@ -0,0 +1,62 @@
+//===- ToolOutputFile.h - Output files for compiler-like tools -----------===//
+//
+// 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 the ToolOutputFile class.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_SUPPORT_TOOLOUTPUTFILE_H
+#define LLVM_SUPPORT_TOOLOUTPUTFILE_H
+
+#include "llvm/Support/raw_ostream.h"
+
+namespace llvm {
+
+/// This class contains a raw_fd_ostream and adds a few extra features commonly
+/// needed for compiler-like tool output files:
+/// - The file is automatically deleted if the process is killed.
+/// - The file is automatically deleted when the ToolOutputFile
+/// object is destroyed unless the client calls keep().
+class ToolOutputFile {
+ /// This class is declared before the raw_fd_ostream so that it is constructed
+ /// before the raw_fd_ostream is constructed and destructed after the
+ /// raw_fd_ostream is destructed. It installs cleanups in its constructor and
+ /// uninstalls them in its destructor.
+ class CleanupInstaller {
+ /// The name of the file.
+ std::string Filename;
+ public:
+ /// The flag which indicates whether we should not delete the file.
+ bool Keep;
+
+ explicit CleanupInstaller(StringRef Filename);
+ ~CleanupInstaller();
+ } Installer;
+
+ /// The contained stream. This is intentionally declared after Installer.
+ raw_fd_ostream OS;
+
+public:
+ /// This constructor's arguments are passed to raw_fd_ostream's
+ /// constructor.
+ ToolOutputFile(StringRef Filename, std::error_code &EC,
+ sys::fs::OpenFlags Flags);
+
+ ToolOutputFile(StringRef Filename, int FD);
+
+ /// Return the contained raw_fd_ostream.
+ raw_fd_ostream &os() { return OS; }
+
+ /// Indicate that the tool's job wrt this output file has been successful and
+ /// the file should not be deleted.
+ void keep() { Installer.Keep = true; }
+};
+
+} // end llvm namespace
+
+#endif