mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-24 03:33:20 +01:00
ae65e281f3
to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
63 lines
2.1 KiB
C++
63 lines
2.1 KiB
C++
//===- 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
|