/usr/include/Bpp/Io/OutputStream.h is in libbpp-core-dev 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 | //
// File: BppStream.h
// Created by: Julien Dutheil
// Created on: Mon Jan 25 17:41 2010
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
This software is a computer program whose purpose is to provide utilitary
classes. This file belongs to the Bio++ Project.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _BPPSTREAM_H_
#define _BPPSTREAM_H_
#include "../Clonable.h"
//From the STL:
#include <string>
#include <iostream>
#include <fstream>
#include <sstream>
#include <memory>
#include <iomanip>
namespace bpp
{
/**
* @brief OutputStream interface.
*
* This interface define several << operators for outputing messages.
* Wrapper classes for the STL streams are available as special
* implementations, but this interface can be used to redirect the output to
* files or to graphical components for instance.
*/
class OutputStream :
public virtual Clonable
{
public:
virtual OutputStream& operator<<(const std::string& message) = 0;
virtual OutputStream& operator<<(const char* message) = 0;
virtual OutputStream& operator<<(const char& message) = 0;
virtual OutputStream& operator<<(const int& message) = 0;
virtual OutputStream& operator<<(const unsigned int& message) = 0;
virtual OutputStream& operator<<(const long int& message) = 0;
virtual OutputStream& operator<<(const unsigned long int& message) = 0;
virtual OutputStream& operator<<(const double& message) = 0;
virtual OutputStream& operator<<(const long double& message) = 0;
virtual OutputStream& operator<<(const bool& message) = 0;
virtual OutputStream& endLine() = 0;
virtual OutputStream& flush() = 0;
virtual OutputStream& setPrecision(unsigned int digit) = 0;
virtual unsigned int getPrecision() const = 0;
virtual OutputStream& enableScientificNotation(bool yn) = 0;
virtual bool isScientificNotationEnabled() const = 0;
/**
* @name The Clonable interface.
*
* @{
*/
#ifndef NO_VIRTUAL_COV
OutputStream* clone() const = 0;
#endif
/** @} */
};
/**
* @brief Helper implementation of the OutputStream interface.
*/
class AbstractOutputStream :
public virtual OutputStream
{
private:
unsigned int precision_;
bool scienceNotation_;
public:
AbstractOutputStream() : precision_(6), scienceNotation_(false) {}
public:
OutputStream& setPrecision(unsigned int digit)
{
precision_ = digit;
return *this;
}
unsigned int getPrecision() const { return precision_; }
virtual OutputStream& enableScientificNotation(bool yn) { scienceNotation_ = yn; return *this; }
virtual bool isScientificNotationEnabled() const { return scienceNotation_; }
};
/**
* @brief Null output stream (swich off output).
*/
class NullOutputStream :
public AbstractOutputStream
{
public:
NullOutputStream& operator<<(const std::string& message) { return *this; }
NullOutputStream& operator<<(const char* message) { return *this; }
NullOutputStream& operator<<(const char& message) { return *this; }
NullOutputStream& operator<<(const int& message) { return *this; }
NullOutputStream& operator<<(const unsigned int& message) { return *this; }
NullOutputStream& operator<<(const long int& message) { return *this; }
NullOutputStream& operator<<(const unsigned long int& message) { return *this; }
NullOutputStream& operator<<(const double& message) { return *this; }
NullOutputStream& operator<<(const long double& message) { return *this; }
NullOutputStream& operator<<(const bool& message) { return *this; }
NullOutputStream& endLine() { return *this; }
NullOutputStream& flush() { return *this; }
NullOutputStream* clone() const { return new NullOutputStream(*this); }
};
/**
* @brief STL output stream.
*
* This class wraps the std::ostream class.
* It takes as input a pointer toward an existing stream that will then be
* owned by the wrapper, as a smart pointer.
* Any copy of this class will then result in an inactivation of the original
* version (in other word, you can't have two wrappers for the same stream).
*/
class StlOutputStream :
public AbstractOutputStream
{
private:
mutable std::auto_ptr<std::ostream> stream_;
public:
StlOutputStream(std::ostream* stream): stream_(stream) {}
StlOutputStream(const StlOutputStream& stlos) : stream_(stlos.stream_) {}
StlOutputStream& operator=(const StlOutputStream& stlos)
{
stream_ = stlos.stream_;
return *this;
}
public:
StlOutputStream& operator<<(const std::string& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const char* message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const char& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const int& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const unsigned int& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const long int& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const unsigned long int& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& operator<<(const double& message)
{
if (stream_.get())
*stream_ << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
StlOutputStream& operator<<(const long double& message)
{
if (stream_.get())
*stream_ << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
StlOutputStream& operator<<(const bool& message) { if (stream_.get()) *stream_ << message; return *this; }
StlOutputStream& endLine() { if (stream_.get()) *stream_ << std::endl; return *this; }
StlOutputStream& flush() { if (stream_.get()) stream_->flush(); return *this; }
StlOutputStream* clone() const { return new StlOutputStream(*this); }
};
/**
* @brief STL wrapper for output stream.
*
* This class wraps the std::ostream class, by forwarding to the STL class.
* It does not own the STL stream and won't delete it.
*/
class StlOutputStreamWrapper :
public AbstractOutputStream
{
protected:
std::ostream* stream_;
public:
StlOutputStreamWrapper(std::ostream* stream): stream_(stream) {}
StlOutputStreamWrapper(const StlOutputStreamWrapper& stlos) : stream_(stlos.stream_) {}
StlOutputStreamWrapper& operator=(const StlOutputStreamWrapper& stlos) { stream_ = stlos.stream_; return *this; }
public:
StlOutputStreamWrapper& operator<<(const std::string& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const char* message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const char& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const int& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const unsigned int& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const long int& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const unsigned long int& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& operator<<(const double& message)
{
if (stream_)
*stream_ << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
StlOutputStreamWrapper& operator<<(const long double& message)
{
if (stream_)
*stream_ << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
StlOutputStreamWrapper& operator<<(const bool& message) { if (stream_) *stream_ << message; return *this; }
StlOutputStreamWrapper& endLine() { if (stream_) *stream_ << std::endl; return *this; }
StlOutputStreamWrapper& flush() { if (stream_) stream_->flush(); return *this; }
StlOutputStreamWrapper* clone() const { return new StlOutputStreamWrapper(*this); }
};
/**
* @brief Standard output stream.
*
* This class wraps the std::cout stream.
*/
class StdOut :
public AbstractOutputStream
{
public:
OutputStream& operator<<(const std::string& message) { std::cout << message; return *this; }
OutputStream& operator<<(const char* message) { std::cout << message; return *this; }
OutputStream& operator<<(const char& message) { std::cout << message; return *this; }
OutputStream& operator<<(const int& message) { std::cout << message; return *this; }
OutputStream& operator<<(const unsigned int& message) { std::cout << message; return *this; }
OutputStream& operator<<(const long int& message) { std::cout << message; return *this; }
OutputStream& operator<<(const unsigned long int& message) { std::cout << message; return *this; }
OutputStream& operator<<(const double& message)
{
std::cout << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
OutputStream& operator<<(const long double& message)
{
std::cout << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
OutputStream& operator<<(const bool& message) { std::cout << message; return *this; }
OutputStream& endLine() { std::cout << std::endl; return *this; }
OutputStream& flush() { std::cout.flush(); return *this; }
StdOut* clone() const { return new StdOut(*this); }
};
/**
* @brief Standard error stream.
*
* This class wraps the std::cerr stream.
*/
class StdErr :
public AbstractOutputStream
{
public:
OutputStream& operator<<(const std::string& message) { std::cerr << message; return *this; }
OutputStream& operator<<(const char* message) { std::cerr << message; return *this; }
OutputStream& operator<<(const char& message) { std::cerr << std::setprecision(getPrecision()) << message; return *this; }
OutputStream& operator<<(const int& message) { std::cerr << std::setprecision(getPrecision()) << message; return *this; }
OutputStream& operator<<(const unsigned int& message) { std::cerr << message; return *this; }
OutputStream& operator<<(const long int& message) { std::cerr << std::setprecision(getPrecision()) << message; return *this; }
OutputStream& operator<<(const unsigned long int& message) { std::cerr << message; return *this; }
OutputStream& operator<<(const double& message)
{
std::cerr << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
OutputStream& operator<<(const long double& message)
{
std::cerr << std::setprecision(getPrecision()) << (isScientificNotationEnabled() ? std::scientific : std::fixed) << message;
return *this;
}
OutputStream& operator<<(const bool& message) { std::cerr << message; return *this; }
OutputStream& endLine() { std::cerr << std::endl; return *this; }
OutputStream& flush() { std::cerr.flush(); return *this; }
#ifndef NO_VIRTUAL_COV
StdErr* clone() const { return new StdErr(*this); }
#endif
};
/**
* @brief String output stream.
*
* This class wraps the std::ostringstream stream.
*/
class StdStr :
public StlOutputStreamWrapper
{
public:
StdStr(): StlOutputStreamWrapper(new std::ostringstream()){}
std::string str() const { return dynamic_cast<const std::ostringstream*>(stream_)->str();}
~StdStr() { delete stream_;}
};
} // end of namespace bpp;
#endif //_BPPSTREAM_H_
|