LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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
std::string getPath() const
Get the path to the file, as a string.
Definition: Stream.h:168
void setIsFits(bool isFits)
set isFits
Definition: Stream.h:129
Stream()
Definition: Stream.h:61
std::string getSourceData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition: Stream.h:197
bool hasStdStream()
Return true if this Stream has an input or output std::stream.
Definition: Stream.h:73
virtual ~FileStream()
Definition: Stream.h:165
AST wrapper classes and functions.
virtual ~Stream()
Definition: Stream.h:63
std::string getSinkData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition: Stream.h:200
T getline(T... args)
T endl(T... args)
Channel provides input/output of AST objects.
Definition: Channel.h:60
FileStream(std::string const &path, bool doWrite=false)
Construct a FileStream for reading or writing, but not both.
Definition: Stream.h:150
std::string _sourceStr
string containing a local copy of sourced data, so source can return a char * that won&#39;t disappear ri...
Definition: Stream.h:135
STL class.
T resize(T... args)
STL class.
Stream & operator=(Stream const &)=default
bool sink(char const *cstr)
Sink (write) to the stream.
Definition: Stream.h:110
T rdbuf(T... args)
char * data
Definition: BaseRecord.cc:62
void sinkToSource()
Move output/sink data to input/source.
Definition: Stream.h:203
File-based source or sink (not both) for channels.
Definition: Stream.h:142
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131
bool _isFits
is this a FITS stream?
Definition: Stream.h:136
virtual ~StringStream()
Definition: Stream.h:194
T str(T... args)
Stream(std::istream *istreamPtr, std::ostream *ostreamPtr)
Construct a Stream from input and output std::streams.
Definition: Stream.h:51
bool getIsFits() const
get isfits
Definition: Stream.h:125
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132
char const * source()
Source (read) from the stream.
Definition: Stream.h:84
T c_str(T... args)
String-based source and sink for channels.
Definition: Stream.h:180
std::ostream * os
Definition: Schema.cc:746
StringStream(std::string const &data="")
Construct a StringStream.
Definition: Stream.h:187
STL class.
A stream for ast::Channel.
Definition: Stream.h:41