1 //===-- SBStream.cpp ----------------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #include "lldb/API/SBStream.h"
11 #include "SBReproducerPrivate.h"
12 #include "lldb/API/SBFile.h"
13 #include "lldb/Core/StreamFile.h"
14 #include "lldb/Host/FileSystem.h"
15 #include "lldb/Utility/Status.h"
16 #include "lldb/Utility/Stream.h"
17 #include "lldb/Utility/StreamString.h"
20 using namespace lldb_private
;
22 SBStream::SBStream() : m_opaque_up(new StreamString()), m_is_file(false) {
23 LLDB_RECORD_CONSTRUCTOR_NO_ARGS(SBStream
);
26 SBStream::SBStream(SBStream
&&rhs
)
27 : m_opaque_up(std::move(rhs
.m_opaque_up
)), m_is_file(rhs
.m_is_file
) {}
29 SBStream::~SBStream() {}
31 bool SBStream::IsValid() const {
32 LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBStream
, IsValid
);
33 return this->operator bool();
35 SBStream::operator bool() const {
36 LLDB_RECORD_METHOD_CONST_NO_ARGS(bool, SBStream
, operator bool);
38 return (m_opaque_up
!= nullptr);
41 // If this stream is not redirected to a file, it will maintain a local cache
42 // for the stream data which can be accessed using this accessor.
43 const char *SBStream::GetData() {
44 LLDB_RECORD_METHOD_NO_ARGS(const char *, SBStream
, GetData
);
46 if (m_is_file
|| m_opaque_up
== nullptr)
49 return static_cast<StreamString
*>(m_opaque_up
.get())->GetData();
52 // If this stream is not redirected to a file, it will maintain a local cache
53 // for the stream output whose length can be accessed using this accessor.
54 size_t SBStream::GetSize() {
55 LLDB_RECORD_METHOD_NO_ARGS(size_t, SBStream
, GetSize
);
57 if (m_is_file
|| m_opaque_up
== nullptr)
60 return static_cast<StreamString
*>(m_opaque_up
.get())->GetSize();
63 void SBStream::Printf(const char *format
, ...) {
67 va_start(args
, format
);
68 ref().PrintfVarArg(format
, args
);
72 void SBStream::RedirectToFile(const char *path
, bool append
) {
73 LLDB_RECORD_METHOD(void, SBStream
, RedirectToFile
, (const char *, bool), path
,
79 std::string local_data
;
81 // See if we have any locally backed data. If so, copy it so we can then
82 // redirect it to the file so we don't lose the data
84 local_data
= static_cast<StreamString
*>(m_opaque_up
.get())->GetString();
86 auto open_options
= File::eOpenOptionWrite
| File::eOpenOptionCanCreate
;
88 open_options
|= File::eOpenOptionAppend
;
90 open_options
|= File::eOpenOptionTruncate
;
92 llvm::Expected
<FileUP
> file
=
93 FileSystem::Instance().Open(FileSpec(path
), open_options
);
95 LLDB_LOG_ERROR(GetLogIfAllCategoriesSet(LIBLLDB_LOG_API
), file
.takeError(),
96 "Cannot open {1}: {0}", path
);
100 m_opaque_up
= std::make_unique
<StreamFile
>(std::move(file
.get()));
103 // If we had any data locally in our StreamString, then pass that along to
104 // the to new file we are redirecting to.
105 if (!local_data
.empty())
106 m_opaque_up
->Write(&local_data
[0], local_data
.size());
109 void SBStream::RedirectToFileHandle(FILE *fh
, bool transfer_fh_ownership
) {
110 LLDB_RECORD_METHOD(void, SBStream
, RedirectToFileHandle
, (FILE *, bool), fh
,
111 transfer_fh_ownership
);
112 FileSP file
= std::make_unique
<NativeFile
>(fh
, transfer_fh_ownership
);
113 return RedirectToFile(file
);
116 void SBStream::RedirectToFile(SBFile file
) {
117 LLDB_RECORD_METHOD(void, SBStream
, RedirectToFile
, (SBFile
), file
)
118 RedirectToFile(file
.GetFile());
121 void SBStream::RedirectToFile(FileSP file_sp
) {
122 LLDB_RECORD_METHOD(void, SBStream
, RedirectToFile
, (FileSP
), file_sp
);
124 if (!file_sp
|| !file_sp
->IsValid())
127 std::string local_data
;
129 // See if we have any locally backed data. If so, copy it so we can then
130 // redirect it to the file so we don't lose the data
132 local_data
= static_cast<StreamString
*>(m_opaque_up
.get())->GetString();
135 m_opaque_up
= std::make_unique
<StreamFile
>(file_sp
);
138 // If we had any data locally in our StreamString, then pass that along to
139 // the to new file we are redirecting to.
140 if (!local_data
.empty())
141 m_opaque_up
->Write(&local_data
[0], local_data
.size());
144 void SBStream::RedirectToFileDescriptor(int fd
, bool transfer_fh_ownership
) {
145 LLDB_RECORD_METHOD(void, SBStream
, RedirectToFileDescriptor
, (int, bool), fd
,
146 transfer_fh_ownership
);
148 std::string local_data
;
150 // See if we have any locally backed data. If so, copy it so we can then
151 // redirect it to the file so we don't lose the data
153 local_data
= static_cast<StreamString
*>(m_opaque_up
.get())->GetString();
156 m_opaque_up
= std::make_unique
<StreamFile
>(fd
, transfer_fh_ownership
);
159 // If we had any data locally in our StreamString, then pass that along to
160 // the to new file we are redirecting to.
161 if (!local_data
.empty())
162 m_opaque_up
->Write(&local_data
[0], local_data
.size());
165 lldb_private::Stream
*SBStream::operator->() { return m_opaque_up
.get(); }
167 lldb_private::Stream
*SBStream::get() { return m_opaque_up
.get(); }
169 lldb_private::Stream
&SBStream::ref() {
170 if (m_opaque_up
== nullptr)
171 m_opaque_up
.reset(new StreamString());
175 void SBStream::Clear() {
176 LLDB_RECORD_METHOD_NO_ARGS(void, SBStream
, Clear
);
179 // See if we have any locally backed data. If so, copy it so we can then
180 // redirect it to the file so we don't lose the data
184 static_cast<StreamString
*>(m_opaque_up
.get())->Clear();
188 namespace lldb_private
{
192 void RegisterMethods
<SBStream
>(Registry
&R
) {
193 LLDB_REGISTER_CONSTRUCTOR(SBStream
, ());
194 LLDB_REGISTER_METHOD_CONST(bool, SBStream
, IsValid
, ());
195 LLDB_REGISTER_METHOD_CONST(bool, SBStream
, operator bool, ());
196 LLDB_REGISTER_METHOD(const char *, SBStream
, GetData
, ());
197 LLDB_REGISTER_METHOD(size_t, SBStream
, GetSize
, ());
198 LLDB_REGISTER_METHOD(void, SBStream
, RedirectToFile
, (const char *, bool));
199 LLDB_REGISTER_METHOD(void, SBStream
, RedirectToFile
, (FileSP
));
200 LLDB_REGISTER_METHOD(void, SBStream
, RedirectToFile
, (SBFile
));
201 LLDB_REGISTER_METHOD(void, SBStream
, RedirectToFileHandle
, (FILE *, bool));
202 LLDB_REGISTER_METHOD(void, SBStream
, RedirectToFileDescriptor
, (int, bool));
203 LLDB_REGISTER_METHOD(void, SBStream
, Clear
, ());