/usr/include/vmime/utility/stream.hpp is in libvmime-dev 0.9.1-1ubuntu1.
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 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 | //
// VMime library (http://www.vmime.org)
// Copyright (C) 2002-2009 Vincent Richard <vincent@vincent-richard.net>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_UTILITY_STREAM_HPP_INCLUDED
#define VMIME_UTILITY_STREAM_HPP_INCLUDED
#include <istream>
#include <ostream>
#include <sstream>
#include "vmime/config.hpp"
#include "vmime/types.hpp"
#include "vmime/utility/progressListener.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
namespace vmime {
namespace net {
class socket; // forward reference
} // net
} // vmime
#endif
#if defined(_MSC_VER) && (_MSC_VER <= 1200) // VC++6
# include <cstring>
#endif
namespace vmime {
namespace utility {
class stringProxy;
/** Base class for input/output stream.
*/
class stream : public object
{
public:
virtual ~stream() { }
/** Type used to read/write one byte in the stream.
*/
typedef string::value_type value_type;
/** Type used for lengths in streams.
*/
typedef string::size_type size_type;
/** Return the preferred maximum block size when reading
* from or writing to this stream.
*
* @return block size, in bytes
*/
virtual size_type getBlockSize();
};
/** Simple output stream.
*/
class outputStream : public stream
{
public:
/** Write data to the stream.
*
* @param data buffer containing data to write
* @param count number of bytes to write
*/
virtual void write(const value_type* const data, const size_type count) = 0;
/** Flush this output stream and forces any buffered output
* bytes to be written out to the stream.
*/
virtual void flush() = 0;
};
/** Simple input stream.
*/
class inputStream : public stream
{
public:
/** Test for end of stream (no more data to read).
*
* @return true if we have reached the end of stream, false otherwise
*/
virtual bool eof() const = 0;
/** Set the read pointer to the beginning of the stream.
*
* @warning WARNING: this may not work for all stream types.
*/
virtual void reset() = 0;
/** Read data from the stream.
*
* @param data will receive the data read
* @param count maximum number of bytes to read
* @return number of bytes read
*/
virtual size_type read(value_type* const data, const size_type count) = 0;
/** Skip a number of bytes.
*
* @param count maximum number of bytes to ignore
* @return number of bytes skipped
*/
virtual size_type skip(const size_type count) = 0;
};
// Helpers functions
outputStream& operator<<(outputStream& os, const string& str);
outputStream& operator<<(outputStream& os, const stream::value_type c);
#if defined(_MSC_VER) && (_MSC_VER <= 1200) // Internal compiler error with VC++6
inline outputStream& operator<<(outputStream& os, const char* str)
{
os.write(str, ::strlen(str));
return (os);
}
#else
template <int N>
outputStream& operator<<(outputStream& os, const char (&str)[N])
{
os.write(str, N - 1);
return (os);
}
#endif // defined(_MSC_VER) && (_MSC_VER <= 1200)
template <typename T>
outputStream& operator<<(outputStream& os, const T& t)
{
std::ostringstream oss;
oss.imbue(std::locale::classic()); // no formatting
oss << t;
os << oss.str();
return (os);
}
/** Copy data from one stream into another stream using a buffered method.
*
* @param is input stream (source data)
* @param os output stream (destination for data)
* @return number of bytes copied
*/
stream::size_type bufferedStreamCopy(inputStream& is, outputStream& os);
/** Copy data from one stream into another stream using a buffered method
* and notify progress state of the operation.
*
* @param is input stream (source data)
* @param os output stream (destination for data)
* @param length predicted number of bytes to copy
* @param progress listener to notify
* @return number of bytes copied
*/
stream::size_type bufferedStreamCopy(inputStream& is, outputStream& os,
const stream::size_type length, progressListener* progress);
// Adapters
/** An adapter class for C++ standard output streams.
*/
class outputStreamAdapter : public outputStream
{
public:
/** @param os output stream to wrap
*/
outputStreamAdapter(std::ostream& os);
void write(const value_type* const data, const size_type count);
void flush();
private:
std::ostream& m_stream;
};
/** An adapter class for string output.
*/
class outputStreamStringAdapter : public outputStream
{
public:
outputStreamStringAdapter(string& buffer);
void write(const value_type* const data, const size_type count);
void flush();
size_type getBlockSize(){return 8192;}
private:
string& m_buffer;
};
/** An adapter class for byte array output.
*/
class outputStreamByteArrayAdapter : public outputStream
{
public:
outputStreamByteArrayAdapter(byteArray& array);
void write(const value_type* const data, const size_type count);
void flush();
private:
byteArray& m_array;
};
/** An adapter class for C++ standard input streams.
*/
class inputStreamAdapter : public inputStream
{
public:
/** @param is input stream to wrap
*/
inputStreamAdapter(std::istream& is);
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
private:
std::istream& m_stream;
};
/** An adapter class for string input.
*/
class inputStreamStringAdapter : public inputStream
{
public:
inputStreamStringAdapter(const string& buffer);
inputStreamStringAdapter(const string& buffer, const string::size_type begin, const string::size_type end);
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
private:
inputStreamStringAdapter(const inputStreamStringAdapter&);
const string m_buffer; // do _NOT_ keep a reference...
const string::size_type m_begin;
const string::size_type m_end;
string::size_type m_pos;
};
/** An adapter class for stringProxy input.
*/
class inputStreamStringProxyAdapter : public inputStream
{
public:
/** @param buffer stringProxy object to wrap
*/
inputStreamStringProxyAdapter(const stringProxy& buffer);
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
private:
inputStreamStringProxyAdapter(const inputStreamStringProxyAdapter&);
const stringProxy& m_buffer;
string::size_type m_pos;
};
/** An adapter class for pointer to C++ standard input stream.
*/
class inputStreamPointerAdapter : public inputStream
{
public:
/** @param is input stream to wrap
* @param own if set to 'true', the pointer will be deleted when
* this object is destroyed
*/
inputStreamPointerAdapter(std::istream* is, const bool own = true);
~inputStreamPointerAdapter();
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
private:
inputStreamPointerAdapter(const inputStreamPointerAdapter&);
std::istream* m_stream;
const bool m_own;
};
/** An adapter class for reading from an array of bytes.
*/
class inputStreamByteBufferAdapter : public inputStream
{
public:
inputStreamByteBufferAdapter(const byte_t* buffer, size_type length);
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
private:
const byte_t* m_buffer;
const size_type m_length;
size_type m_pos;
};
#if VMIME_HAVE_MESSAGING_FEATURES
/** An output stream that is connected to a socket.
*/
class outputStreamSocketAdapter : public outputStream
{
public:
outputStreamSocketAdapter(net::socket& sok);
void write(const value_type* const data, const size_type count);
void flush();
size_type getBlockSize();
private:
outputStreamSocketAdapter(const outputStreamSocketAdapter&);
net::socket& m_socket;
};
/** An input stream that is connected to a socket.
*/
class inputStreamSocketAdapter : public inputStream
{
public:
inputStreamSocketAdapter(net::socket& sok);
bool eof() const;
void reset();
size_type read(value_type* const data, const size_type count);
size_type skip(const size_type count);
size_type getBlockSize();
private:
inputStreamSocketAdapter(const inputStreamSocketAdapter&);
net::socket& m_socket;
};
#endif // VMIME_HAVE_MESSAGING_FEATURES
} // utility
} // vmime
#endif // VMIME_UTILITY_STREAM_HPP_INCLUDED
|