LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
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"
32#include "astshim/Object.h"
33
34namespace ast {
35
36class Channel; // forward declaration for friendship
37
41class Stream {
42public:
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
127protected:
129 void setIsFits(bool isFits) { _isFits = isFits; }
130
136 bool _isFits;
137};
138
142class FileStream : public Stream {
143public:
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
170private:
171 std::string _path;
172};
173
180class StringStream : public Stream {
181public:
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
204 _istringstreamPtr->clear();
205 _istringstreamPtr->str(getSinkData());
206 _ostringstreamPtr->str("");
207 }
208
209private:
211 std::shared_ptr<std::istringstream> _istringstreamPtr;
213 std::shared_ptr<std::ostringstream> _ostringstreamPtr;
214};
215
216namespace detail {
217
224inline 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
239inline 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
char * data
Definition BaseRecord.cc:61
std::ostream * os
Definition Schema.cc:557
T c_str(T... args)
Channel provides input/output of AST objects.
Definition Channel.h:60
File-based source or sink (not both) for channels.
Definition Stream.h:142
virtual ~FileStream()
Definition Stream.h:165
FileStream(std::string const &path, bool doWrite=false)
Construct a FileStream for reading or writing, but not both.
Definition Stream.h:150
std::string getPath() const
Get the path to the file, as a string.
Definition Stream.h:168
A stream for ast::Channel.
Definition Stream.h:41
bool getIsFits() const
get isfits
Definition Stream.h:125
bool _isFits
is this a FITS stream?
Definition Stream.h:136
Stream(Stream const &)=default
bool hasStdStream()
Return true if this Stream has an input or output std::stream.
Definition Stream.h:73
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
Stream(std::istream *istreamPtr, std::ostream *ostreamPtr)
Construct a Stream from input and output std::streams.
Definition Stream.h:51
bool sink(char const *cstr)
Sink (write) to the stream.
Definition Stream.h:110
Stream & operator=(Stream const &)=default
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition Stream.h:132
Stream & operator=(Stream &&)=default
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition Stream.h:131
Stream(Stream &&)=default
char const * source()
Source (read) from the stream.
Definition Stream.h:84
virtual ~Stream()
Definition Stream.h:63
void setIsFits(bool isFits)
set isFits
Definition Stream.h:129
String-based source and sink for channels.
Definition Stream.h:180
std::string getSourceData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition Stream.h:197
StringStream(std::string const &data="")
Construct a StringStream.
Definition Stream.h:187
void sinkToSource()
Move output/sink data to input/source.
Definition Stream.h:203
std::string getSinkData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition Stream.h:200
virtual ~StringStream()
Definition Stream.h:194
T clear(T... args)
T endl(T... args)
T getline(T... args)
const char * source()
Source function that allows astChannel to source from a Stream.
Definition Stream.h:224
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition Stream.h:239
AST wrapper classes and functions.
T rdbuf(T... args)
T read(T... args)
T resize(T... args)
T str(T... args)