lldb/Host/StreamFile.h

0001 //===-- StreamFile.h --------------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_HOST_STREAMFILE_H
0010 #define LLDB_HOST_STREAMFILE_H
0011
0012 #include "lldb/Host/File.h"
0013 #include "lldb/Utility/Stream.h"
0014 #include "lldb/lldb-defines.h"
0015 #include "lldb/lldb-enumerations.h"
0016
0017 #include <cstdint>
0018 #include <cstdio>
0019
0020 namespace lldb_private {
0021
0022 class StreamFile : public Stream {
0023 public:
0024   StreamFile(uint32_t flags, uint32_t addr_size, lldb::ByteOrder byte_order);
0025
0026   StreamFile(int fd, bool transfer_ownership);
0027
0028   StreamFile(const char *path, File::OpenOptions options,
0029              uint32_t permissions = lldb::eFilePermissionsFileDefault);
0030
0031   StreamFile(FILE *fh, bool transfer_ownership);
0032
0033   StreamFile(std::shared_ptr<File> file) : m_file_sp(file) { assert(file); };
0034
0035   ~StreamFile() override;
0036
0037   File &GetFile() { return *m_file_sp; }
0038
0039   const File &GetFile() const { return *m_file_sp; }
0040
0041   std::shared_ptr<File> GetFileSP() { return m_file_sp; }
0042
0043   void Flush() override;
0044
0045 protected:
0046   // Classes that inherit from StreamFile can see and modify these
0047   std::shared_ptr<File> m_file_sp; // never NULL
0048   size_t WriteImpl(const void *s, size_t length) override;
0049
0050 private:
0051   StreamFile(const StreamFile &) = delete;
0052   const StreamFile &operator=(const StreamFile &) = delete;
0053 };
0054
0055 } // namespace lldb_private
0056
0057 #endif // LLDB_HOST_STREAMFILE_H