LSSTApplications  19.0.0-14-gb0260a2+68b5710e34,20.0.0+34a42eae2c,20.0.0+5e413b1bb7,20.0.0+8220981c08,20.0.0+8558dd3f48,20.0.0+9105c11c27,20.0.0+9c492b2baa,20.0.0+b290a576ab,20.0.0+b2ea66fa67,20.0.0+bdb47f006b,20.0.0+c80b78a72c,20.0.0+ca71b4c878,20.0.0+dcf29472a8,20.0.0+f45b7d88f4,20.0.0+ff38a75775,20.0.0-1-g10df615+0301c91ccb,20.0.0-1-g253301a+dcf29472a8,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+0fef26433e,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+9c492b2baa,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+60996fbbb1,20.0.0-11-gda4966f+51d1f94bfc,20.0.0-17-g98646ba4+6d72394450,20.0.0-2-g25c5319+53d663580f,20.0.0-2-gec03fae+3bc057fb2a,20.0.0-27-g22bab1b+63c2eb6a9e,20.0.0-3-gd2e950e+f45b7d88f4,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-4-ge48a6ca+6f08222a1e,20.0.0-5-gac0d578b1+6c871ee35c,20.0.0-6-g01203fff+c632a9a46a,20.0.0-7-g3c4151b+49dfb5b924,20.0.0-8-g9573cbd+60996fbbb1,20.0.0-8-gc2abeef+9c492b2baa,w.2020.32
LSSTDataManagementBasePackage
Stream.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2017 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #ifndef ASTSHIM_SOURCESINK_H
23 #define ASTSHIM_SOURCESINK_H
24 
25 #include <string>
26 #include <fstream>
27 #include <sstream>
28 #include <iostream>
29 
30 #include "astshim/base.h"
31 #include "astshim/detail/utils.h"
32 #include "astshim/Object.h"
33 
34 namespace ast {
35 
36 class Channel; // forward declaration for friendship
37 
41 class Stream {
42 public:
51  explicit Stream(std::istream *istreamPtr, std::ostream *ostreamPtr)
52  : _istreamPtr(), _ostreamPtr(), _sourceStr(), _isFits(false) {
53  if (istreamPtr) {
54  _istreamPtr = std::make_shared<std::istream>(istreamPtr->rdbuf());
55  }
56  if (ostreamPtr) {
57  _ostreamPtr = std::make_shared<std::ostream>(ostreamPtr->rdbuf());
58  }
59  }
60 
61  explicit Stream() : Stream(nullptr, nullptr) {}
62 
63  virtual ~Stream() {}
64 
65  Stream(Stream const &) = default;
66  Stream(Stream &&) = default;
67  Stream &operator=(Stream const &) = default;
68  Stream &operator=(Stream &&) = default;
69 
73  bool hasStdStream() { return _istreamPtr || _ostreamPtr; }
74 
84  char const *source() {
85  if ((_istreamPtr) && (*_istreamPtr)) {
86  if (_isFits) {
87  // http://codereview.stackexchange.com/a/28759
88  _sourceStr.resize(detail::FITSLEN);
89  _istreamPtr->read(&_sourceStr[0], detail::FITSLEN);
90  } else {
92  }
93  if (*_istreamPtr) {
94  return _sourceStr.c_str();
95  }
96  }
97  return nullptr;
98  }
99 
110  bool sink(char const *cstr) {
111  if (_ostreamPtr) {
112  (*_ostreamPtr) << cstr;
113  if (!_isFits) {
114  (*_ostreamPtr) << std::endl;
115  }
116  return static_cast<bool>(*_ostreamPtr);
117  } else {
118  return true;
119  }
120  }
121 
122  friend class Channel;
123 
125  bool getIsFits() const { return _isFits; }
126 
127 protected:
129  void setIsFits(bool isFits) { _isFits = isFits; }
130 
136  bool _isFits;
137 };
138 
142 class FileStream : public Stream {
143 public:
150  explicit FileStream(std::string const &path, bool doWrite = false) : Stream(), _path(path) {
151  auto mode = doWrite ? std::ios_base::out : std::ios_base::in;
152  auto fstreamPtr = std::make_shared<std::fstream>(path, mode);
153  if (!*fstreamPtr) {
155  os << "Failed to open file \"" << path << "\" for " << (doWrite ? "writing" : "reading");
156  throw std::runtime_error(os.str());
157  }
158  if (doWrite) {
159  _ostreamPtr = fstreamPtr;
160  } else {
161  _istreamPtr = fstreamPtr;
162  }
163  }
164 
165  virtual ~FileStream() {}
166 
168  std::string getPath() const { return _path; }
169 
170 private:
171  std::string _path;
172 };
173 
180 class StringStream : public Stream {
181 public:
187  explicit StringStream(std::string const &data = "") : Stream(), _istringstreamPtr(), _ostringstreamPtr() {
188  _istringstreamPtr = std::make_shared<std::istringstream>(data);
189  _ostringstreamPtr = std::make_shared<std::ostringstream>();
190  _istreamPtr = _istringstreamPtr;
191  _ostreamPtr = _ostringstreamPtr;
192  }
193 
194  virtual ~StringStream() {}
195 
197  std::string getSourceData() const { return _istringstreamPtr->str(); }
198 
200  std::string getSinkData() const { return _ostringstreamPtr->str(); }
201 
203  void sinkToSource() {
204  _istringstreamPtr->clear();
205  _istringstreamPtr->str(getSinkData());
206  _ostringstreamPtr->str("");
207  }
208 
209 private:
211  std::shared_ptr<std::istringstream> _istringstreamPtr;
213  std::shared_ptr<std::ostringstream> _ostringstreamPtr;
214 };
215 
216 namespace detail {
217 
224 inline const char *source() {
225  auto ssptr = reinterpret_cast<Stream *>(astChannelData);
226  if (ssptr) {
227  return ssptr->source();
228  } else {
229  return nullptr;
230  }
231 }
232 
239 inline void sink(const char *cstr) {
240  auto ssptr = reinterpret_cast<Stream *>(astChannelData);
241  if (ssptr) {
242  auto isok = ssptr->sink(cstr);
243  if (!isok) {
244  astSetStatus(AST__ATGER);
245  }
246  }
247 }
248 
249 } // namespace detail
250 
251 } // namespace ast
252 
253 #endif
utils.h
ast::FileStream
File-based source or sink (not both) for channels.
Definition: Stream.h:142
std::string::resize
T resize(T... args)
std::istream::rdbuf
T rdbuf(T... args)
base.h
std::string
STL class.
std::shared_ptr< std::istream >
ast::Stream::source
char const * source()
Source (read) from the stream.
Definition: Stream.h:84
ast::Stream::_sourceStr
std::string _sourceStr
string containing a local copy of sourced data, so source can return a char * that won't disappear ri...
Definition: Stream.h:135
ast::Stream::Stream
Stream(std::istream *istreamPtr, std::ostream *ostreamPtr)
Construct a Stream from input and output std::streams.
Definition: Stream.h:51
ast::StringStream::~StringStream
virtual ~StringStream()
Definition: Stream.h:194
ast::StringStream::getSinkData
std::string getSinkData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition: Stream.h:200
std::istream::read
T read(T... args)
ast::Stream::setIsFits
void setIsFits(bool isFits)
set isFits
Definition: Stream.h:129
std::istringstream::clear
T clear(T... args)
ast::Stream::sink
bool sink(char const *cstr)
Sink (write) to the stream.
Definition: Stream.h:110
ast::Channel
Channel provides input/output of AST objects.
Definition: Channel.h:60
ast::Stream
A stream for ast::Channel.
Definition: Stream.h:41
ast::StringStream::getSourceData
std::string getSourceData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition: Stream.h:197
ast::Stream::Stream
Stream()
Definition: Stream.h:61
data
char * data
Definition: BaseRecord.cc:62
ast::detail::source
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
std::ostream
STL class.
std::string::c_str
T c_str(T... args)
ast::Stream::operator=
Stream & operator=(Stream &&)=default
std::runtime_error
STL class.
ast::Stream::Stream
Stream(Stream const &)=default
ast::FileStream::~FileStream
virtual ~FileStream()
Definition: Stream.h:165
ast::Stream::operator=
Stream & operator=(Stream const &)=default
ast::StringStream
String-based source and sink for channels.
Definition: Stream.h:180
ast::Stream::Stream
Stream(Stream &&)=default
std::ostringstream
STL class.
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
std::endl
T endl(T... args)
ast::Stream::hasStdStream
bool hasStdStream()
Return true if this Stream has an input or output std::stream.
Definition: Stream.h:73
std::getline
T getline(T... args)
ast::StringStream::sinkToSource
void sinkToSource()
Move output/sink data to input/source.
Definition: Stream.h:203
ast::Stream::~Stream
virtual ~Stream()
Definition: Stream.h:63
ast::FileStream::getPath
std::string getPath() const
Get the path to the file, as a string.
Definition: Stream.h:168
std::istringstream::str
T str(T... args)
ast::Stream::_istreamPtr
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
ast::Stream::_isFits
bool _isFits
is this a FITS stream?
Definition: Stream.h:136
ast::FileStream::FileStream
FileStream(std::string const &path, bool doWrite=false)
Construct a FileStream for reading or writing, but not both.
Definition: Stream.h:150
std::istream
STL class.
Object.h
ast::Stream::_ostreamPtr
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132
ast::detail::sink
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
ast::StringStream::StringStream
StringStream(std::string const &data="")
Construct a StringStream.
Definition: Stream.h:187
ast::Stream::getIsFits
bool getIsFits() const
get isfits
Definition: Stream.h:125