lineStream.h

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file lineStream.h
 * @author drose
 * @date 2000-02-26
 */

#ifndef LINESTREAM_H
#define LINESTREAM_H

#include "dtoolbase.h"

#include "lineStreamBuf.h"

/**
 * This is a special ostream that writes to a memory buffer, like ostrstream.
 * However, its contents can be continuously extracted as a sequence of lines
 * of text.
 *
 * Unlike ostrstream, which can only be extracted from once (and then the
 * buffer freezes and it can no longer be written to), the LineStream is not
 * otherwise affected when a line of text is extracted.  More text can still
 * be written to it and continuously extracted.
 */
class EXPCL_DTOOL_DTOOLUTIL LineStream : public std::ostream {
PUBLISHED:
  INLINE LineStream();

#if _MSC_VER >= 1800
  INLINE LineStream(const LineStream &copy) = delete;
#endif

  INLINE bool is_text_available() const;
  INLINE std::string get_line();
  INLINE bool has_newline() const;

private:
  LineStreamBuf _lsb;
};

#include "lineStream.I"

#endif