NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
CStreamLineReader Class Reference

Search Toolkit Book for CStreamLineReader

Simple implementation of ILineReader for i(o)streams. More...

#include <util/line_reader.hpp>

+ Inheritance diagram for CStreamLineReader:
+ Collaboration diagram for CStreamLineReader:

Public Types

enum  EEOLStyle {
  eEOL_unknown = 0 , eEOL_cr = 1 , eEOL_lf = 2 , eEOL_crlf = 3 ,
  eEOL_native = eEOL_lf , eEOL_mixed = 4
}
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CStreamLineReader (CNcbiIstream &is, EEOLStyle eol_style=eEOL_unknown, EOwnership ownership=eNoOwnership)
 Open a line reader over a given stream, with the given EOL-style and ownership settings (if specified). More...
 
 CStreamLineReader (CNcbiIstream &is, EOwnership ownership)
 Open a line reader over a given stream, with the given ownership setting. More...
 
 ~CStreamLineReader ()
 
bool AtEOF (void) const
 Indicates (negatively) whether there is any more input. More...
 
char PeekChar (void) const
 Returns the first character of the next string without consuming it. More...
 
CStreamLineReaderoperator++ (void)
 Make a line available. More...
 
void UngetLine (void)
 Unget current line, which must be valid. More...
 
CTempString operator* (void) const
 Return the current line, minus its terminator. More...
 
CT_POS_TYPE GetPosition (void) const
 Return the current (absolute) position. More...
 
Uint8 GetLineNumber (void) const
 Returns the current line number (counting from 1, not 0). More...
 
- Public Member Functions inherited from ILineReader
void ReadLine (void)
 
CTempString GetCurrentLine (void) const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Private Member Functions

EEOLStyle x_AdvanceEOLUnknown (void)
 
EEOLStyle x_AdvanceEOLSimple (char eol, char alt_eol)
 
EEOLStyle x_AdvanceEOLCRLF (void)
 

Private Attributes

AutoPtr< CNcbiIstreamm_Stream
 
string m_Line
 
Uint8 m_LineNumber
 
SIZE_TYPE m_LastReadSize
 
bool m_UngetLine
 
bool m_AutoEOL
 
EEOLStyle m_EOLStyle
 

Additional Inherited Members

- Static Public Member Functions inherited from ILineReader
static CRef< ILineReaderNew (const string &filename)
 Return a new ILineReader object corresponding to the given filename, taking "-" (but not "./-") to mean standard input. More...
 
static CRef< ILineReaderNew (CNcbiIstream &is, EOwnership ownership=eNoOwnership)
 Return a new ILineReader object corresponding to the given input stream, optionally taking ownership thereof. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Simple implementation of ILineReader for i(o)streams.

Definition at line 119 of file line_reader.hpp.


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:02:27 2024 by modify_doxy.py rev. 669887