1 //===- ToolOutputFile.h - Output files for compiler-like tools -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the tool_output_file class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_TOOLOUTPUTFILE_H
15 #define LLVM_SUPPORT_TOOLOUTPUTFILE_H
17 #include "llvm/Support/raw_ostream.h"
21 /// This class contains a raw_fd_ostream and adds a few extra features commonly
22 /// needed for compiler-like tool output files:
23 /// - The file is automatically deleted if the process is killed.
24 /// - The file is automatically deleted when the tool_output_file
25 /// object is destroyed unless the client calls keep().
26 class tool_output_file {
27 /// This class is declared before the raw_fd_ostream so that it is constructed
28 /// before the raw_fd_ostream is constructed and destructed after the
29 /// raw_fd_ostream is destructed. It installs cleanups in its constructor and
30 /// uninstalls them in its destructor.
31 class CleanupInstaller {
32 /// The name of the file.
35 /// The flag which indicates whether we should not delete the file.
38 explicit CleanupInstaller(StringRef ilename);
42 /// The contained stream. This is intentionally declared after Installer.
46 /// This constructor's arguments are passed to to raw_fd_ostream's
48 tool_output_file(StringRef Filename, std::error_code &EC,
49 sys::fs::OpenFlags Flags);
51 tool_output_file(StringRef Filename, int FD);
53 /// Return the contained raw_fd_ostream.
54 raw_fd_ostream &os() { return OS; }
56 /// Indicate that the tool's job wrt this output file has been successful and
57 /// the file should not be deleted.
58 void keep() { Installer.Keep = true; }
61 } // end llvm namespace