rnr::LogBook Class Reference

Classes
struct	BookMark
	Log bookmark structure. More...
struct	Entry
	Log entry structure. More...

Public Types
typedef std::vector< Entry >	EntryList
	entry list type
typedef EntryList::iterator	EntryListIter
	entry list iterator
typedef EntryList::const_iterator	EntryListCIter
	entry const list iterator
typedef std::vector< BookMark >	BookMarkList
	bookmark list type
typedef BookMarkList::iterator	BookMarkListIter
	bookmark list iterator
typedef BookMarkList::const_iterator	BookMarkListCIter
	bookmark const list iter

Public Member Functions
	LogBook (const std::string strName="Log Book", size_t uMaxEntries=MaxEntriesDft, size_t uMaxEntryLen=MaxEntryLenDft)
	Default initialization constructor. More...
	LogBook (const LogBook &src)
	Copy constructor. More...
virtual	~LogBook ()
	Destructor.
LogBook &	operator= (const LogBook &rhs)
	Assignment operator. More...
LogBook &	operator<< (bool val)
LogBook &	operator<< (char val)
LogBook &	operator<< (int val)
LogBook &	operator<< (unsigned int val)
LogBook &	operator<< (long val)
LogBook &	operator<< (unsigned long val)
LogBook &	operator<< (long long val)
LogBook &	operator<< (unsigned long long val)
LogBook &	operator<< (float val)
LogBook &	operator<< (double val)
LogBook &	operator<< (long double val)
LogBook &	operator<< (const char *val)
LogBook &	operator<< (void *val)
LogBook &	operator<< (const std::string &val)
LogBook &	operator<< (const LogBook &log)
LogBook &	operator<< (LogBook &(*pf)(LogBook &))
LogBook &	operator<< (std::ostream &(*pf)(std::ostream &))
LogBook &	operator<< (std::ios &(*pf)(std::ios &))
LogBook &	operator<< (std::ios_base &(*pf)(std::ios_base &))
size_t	logEntry (const std::string strText, const std::string strMark="")
	Log the given entry into the log book. More...
size_t	logPending ()
	Log any pending entry into the log book. More...
void	setPendingText (const std::string strText)
	Set the pending log text. More...
void	setPendingBookMark (const std::string strMark)
	Set the pending bookmark. More...
void	setPending (const std::string strText, const std::string strMark)
	Set the pending log text and associated bookmark. More...
void	erasePendingText ()
	Erase the pending log text.
void	erasePendingBookMark ()
	Erase the pending log bookmark.
void	erasePending ()
	Erase the pending log text and associated bookmark.
size_t	eraseToMark (const std::string strMark, int whence)
	Erases all entries from the log book up to the bookmark. More...
size_t	eraseEntries (size_t uNumEntries, int whence)
	Erases a given number of entries from the log book. More...
void	clear ()
	Clear the log book and bookmarks, along with any pending entry.
const Entry &	at (const std::string &strMark) const
	Get the entry at the bookmark. More...
const Entry &	at (const size_t index) const
	Get the entry at the index. More...
const Entry &	at (const size_t index, int whence) const
	Get the entry at relative index from whence. More...
const Entry &	operator[] (const size_t index) const
	Log book array index operator. More...
const Entry &	operator[] (const std::string &strMark) const
	Log book array mark operator. More...
const Entry &	lastEntry () const
	Get the last (latest) log entry. More...
const std::string &	textAt (const std::string &strMark) const
	Get the entry text at the bookmark. More...
const std::string &	textAt (const size_t index) const
	Get the entry text at the index. More...
const std::string &	textAt (const size_t index, int whence) const
	Get the entry text at relative index from whence. More...
const std::string &	lastText () const
	Get the last (latest) log entry text. More...
size_t	getBookMarks (BookMarkList &list, int whence) const
	Get a sorted list of bookmark labels. More...
bool	hasBookMark (const std::string &strMark) const
	Test if bookmark exists in log book. More...
const std::string &	getName () const
	Get the name of the log book. More...
void	setName (const std::string &strName)
	Set the name of the log book. More...
const size_t	max_size () const
	Return the maximum number entries the log book can hold. More...
size_t	size () const
	Return the number of logged entries in the log book. More...
void	resize (size_t uMaxEntries)
	Resize maximum size of log book. More...
size_t	numOfTotalEver () const
	Return the total number of entries ever added during log book's life. More...
unsigned	getFlags () const
	Get the current formatting flags. More...
unsigned	setFlags (const unsigned uFlags)
	Set the current formatting flags. More...
unsigned	orFlags (const unsigned uFlags)
	Or new flags into the current formatting flags. More...
unsigned	compAndFlags (const unsigned uFlags)
	Apply one's Complement and And into the current formatting flags. More...
void	clearFlags ()
	Clear alll current formatting flags.
std::string	makeBookMarkLabel ()
	Generate a unique bookmark label. More...
std::ostream &	printLog (std::ostream &os) const
	Print the entire log book to the output stream. More...
std::ostream &	printToMark (std::ostream &os, const std::string strMark, int endpt) const
	Print the log book entires between the bookmark and the specified end point to the output stream. More...

Static Public Attributes
static const size_t	MaxEntriesDft = 100
	max num entries default
static const size_t	MaxEntryLenDft = 0x2000
	max entry length (8192)
static const int	OLDEST = 0
	oldest entries
static const int	NEWEST = 1
	newest, most recent entries
static const unsigned	FlagNone = 0x0000
	no flags
static const unsigned	FlagONum = 0x0001
	output log entry number
static const unsigned	FlagOTime = 0x0002
	output log entry time
static const unsigned	FlagOMark = 0x0004
	output log entry bookmarks
static const unsigned	FlagOAllF = 0x0007
	output all entry fields
static const unsigned	FlagORev = 0x0008
	output log reverse order
static const unsigned	FlagDebug = 0x1000
	debug

Protected Types
typedef std::deque< Entry >	BookDeq
	book type
typedef BookDeq::iterator	BookIter
	book iterator
typedef BookDeq::const_iterator	BookCIter
	book const iterator
typedef BookDeq::reverse_iterator	BookRIter
	reverse book iter
typedef BookDeq::const_reverse_iterator	BookCRIter
	const rev book iter

Protected Member Functions
void	limitSize ()
	Limit size of log book to defined limit.
void	ssflush ()
	Flush the pending text stream. More...
bool	checkLen (size_t uEstLen=1)
	Check the length of the pending entry. More...
BookIter	findMark (const std::string &strMark)
	Find position it log book of the bookmarked entry. More...
BookCIter	findMark (const std::string &strMark) const
	Find position it log book of the bookmarked entry. More...
void	sortMarks (BookMarkList &sorted) const
	Sort bookmarks from oldest to newest. More...
void	rsortMarks (BookMarkList &sorted) const
	Reverse sort bookmarks from newest to oldest. More...
void	copy (const LogBook &src)
	Copy log book verbatim to this log book. More...
void	prt (std::ostream &os, size_t index0, size_t index1) const
	Print log book from index 0 to index 1, inclusive. More...
void	rprt (std::ostream &os, size_t index0, size_t index1) const
	Reverse print log book from index 1 to index 0, inclusive. More...

Protected Attributes
std::string	m_strName
	name of log
size_t	m_uMaxEntries
	maximum number of log entries
size_t	m_uMaxEntryLen
	maximum entry length
size_t	m_uTotalEver
	total entries added during lifetime
unsigned	m_uFlags
	formatting flags
bool	m_bWarnThrottle
	do [not] throttle warnings
std::string	m_strMark
	pending bookmark label
std::stringstream	m_ssText
	pending text stream
BookDeq	m_book
	the log book

Friends
std::ostream &	operator<< (std::ostream &os, const LogBook &log)
	Stream insertion operator. More...

Detailed Description

Definition at line 79 of file LogBook.h.

Constructor & Destructor Documentation

LogBook::LogBook	(	const std::string	strName = "Log Book",
		size_t	uMaxEntries = MaxEntriesDft,
		size_t	uMaxEntryLen = MaxEntryLenDft
	)

Default initialization constructor.

Parameters

strName	Name of log book.
uMaxEntries	Maximum number of entries in log book.
uMaxEntryLen	Maximum entry length.

Definition at line 148 of file LogBook.cxx.

References FlagONum, m_bWarnThrottle, m_uFlags, and m_uTotalEver.

                                                 :
    m_strName(strName),
    m_uMaxEntries(uMaxEntries),
    m_uMaxEntryLen(uMaxEntryLen)

{
  m_uTotalEver    = 0;
  m_uFlags        = FlagONum;
  m_bWarnThrottle = false;
}

LogBook::LogBook

(

const LogBook &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 161 of file LogBook.cxx.

References copy().

{
  copy(src);
}

Member Function Documentation

const Entry& rnr::LogBook::at

(

const std::string &

strMark

)

const

Get the entry at the bookmark.

Parameters

strMark

Bookmark label.

Returns

If the entry exists, reference to log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Referenced by clear(), operator[](), and textAt().

const LogBook::Entry & LogBook::at

(

const size_t

index

)

const

Get the entry at the index.

Parameters

index

Log book absolute index.

Returns

If the entry exists, reference to log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Definition at line 544 of file LogBook.cxx.

References m_book, and size().

{
  if( index < size() )
  {
    return m_book[index];
  }
  else
  {
    return noentry;
  }
}

const LogBook::Entry & LogBook::at	(	const size_t	index,
		int	whence
	)		const

Get the entry at relative index from whence.

Parameters

index	Relative log book index.
whence	Whence directive (OLDEST or NEWEST).

Returns

If the entry exists, reference to log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Definition at line 556 of file LogBook.cxx.

References m_book, NEWEST, and size().

{
  size_t  i;

  if( index < size() )
  {
    i = whence == NEWEST? size() - index - 1: index;
    return m_book[i];
  }
  else
  {
    return noentry;
  }
}

bool LogBook::checkLen ( size_t  uEstLen = 1 )

protected

Check the length of the pending entry.

Parameters

uEstLen

Estimated length of the new object text to be added.

Returns

Returns true if pending entry within bounds, false otherwise.

Definition at line 804 of file LogBook.cxx.

References findMark(), m_book, m_bWarnThrottle, m_ssText, and m_uMaxEntryLen.

Referenced by operator=().

{
  if( m_ssText.str().size()+uEstLen < m_uMaxEntryLen )
  {
    return true;
  }
  else
  {
    if( !m_bWarnThrottle )
    {
      LOGWARN("Pending entry exceeds max entry length %zu.", m_uMaxEntryLen);
      m_bWarnThrottle = true;
    }
    return false;
  }
}

unsigned rnr::LogBook::compAndFlags ( const unsigned  uFlags )

inline

Apply one's Complement and And into the current formatting flags.

Parameters

uFlags

Flags to unset.

Returns

New bit list of or'ed flags.

Definition at line 656 of file LogBook.h.

References m_uFlags.

    {
      m_uFlags &= ~uFlags;
      return m_uFlags;
    }

void LogBook::copy ( const LogBook &  src )

protected

Copy log book verbatim to this log book.

Parameters

src	Source log book.

Definition at line 911 of file LogBook.cxx.

References m_book, m_strName, m_uFlags, m_uMaxEntries, m_uMaxEntryLen, and m_uTotalEver.

Referenced by LogBook(), and operator=().

{
  m_strName       = src.m_strName;
  m_uMaxEntries   = src.m_uMaxEntries;
  m_uMaxEntryLen  = src.m_uMaxEntryLen;
  m_uTotalEver    = src.m_uTotalEver;
  m_uFlags        = src.m_uFlags;
  m_book          = src.m_book;
}

size_t LogBook::eraseEntries	(	size_t	uNumEntries,
		int	whence
	)

Erases a given number of entries from the log book.

If whence is OLDEST, then the entries are erased starting from the oldest entry.

If whence is NEWEST, then the entries are erased starting from the most recent entry.

Parameters

uNumEntries	Number of entries to delete. If >= number of entries, then the book is erased.
whence	Whence directive (OLDEST or NEWEST).

Returns

Returns the new number of entries in the log book.

Definition at line 483 of file LogBook.cxx.

References m_book, NEWEST, OLDEST, and size().

Referenced by limitSize().

{
  BookIter  first, last;

  if( uNumEntries > size() )
  {
    uNumEntries = size();
  }

  switch( whence )
  {
    case OLDEST:
      first = m_book.begin();
      last  = first + uNumEntries;
      m_book.erase(first, last);
      break;
    case NEWEST:
      last  = m_book.end();
      first = last - uNumEntries;
      m_book.erase(first, last);
      break;
    default:
      LOGERROR("Unknown whence = %d", whence);
      break;
  }

  return size();
}

size_t LogBook::eraseToMark	(	const std::string	strMark,
		int	whence
	)

Erases all entries from the log book up to the bookmark.

If whence is OLDEST, then the entries erased are from the oldest entries up to, but not including, the first encounter of the bookmarked entry.

If whence is NEWEST, then the entries erased are from the most recent logged entry up to and including the first encounter of the bookmarked entry.

If the bookmark is not found, then no entries are erased.

Parameters

strMark	Bookmark search label.
whence	Whence directive (OLDEST or NEWEST).

Returns

Returns the new number of entries in the log book.

Definition at line 457 of file LogBook.cxx.

References findMark(), m_book, NEWEST, OLDEST, and size().

{
  BookIter    pos;

  // no bookmark found
  if( (pos = findMark(strMark)) == m_book.end() )
  {
    return size();
  }

  switch( whence )
  {
    case NEWEST:
      m_book.erase(pos, m_book.end());
      break;
    case OLDEST:
      m_book.erase(m_book.begin(), pos);
      break;
    default:
      LOGERROR("Unknown whence = %d", whence);
      break;
  }

  return size();
}

BookIter rnr::LogBook::findMark ( const std::string &  strMark )

protected

Find position it log book of the bookmarked entry.

The search starts at the oldest entry.

Parameters

strMark

Bookmark search label.

Returns

If the bookmark entry is found, the position is returned. Otherwise, book end() is returned.

Referenced by checkLen(), clear(), eraseToMark(), hasBookMark(), and printToMark().

BookCIter rnr::LogBook::findMark ( const std::string &  strMark ) const

protected

Find position it log book of the bookmarked entry.

Constant version.

The search starts at the oldest entry.

Parameters

strMark

Bookmark search label.

Returns

If the bookmark entry is found, the position is returned. Otherwise, book end() is returned.

size_t LogBook::getBookMarks	(	BookMarkList &	list,
		int	whence
	)		const

Get a sorted list of bookmark labels.

If whence is OLDEST, then sort from oldest to newest. If whence is NEWEST, then sort from most recent to oldest.

Parameters

[out]	list	List of sorted bookmark labels.
	whence	Whence directive (OLDEST or NEWEST).

Returns

Number of bookmarks in list.

Definition at line 594 of file LogBook.cxx.

References NEWEST, OLDEST, rsortMarks(), and sortMarks().

Referenced by lastText(), and mainInit().

{
  switch( whence )
  {
    case OLDEST:
      sortMarks(list);
      break;
    case NEWEST:
      rsortMarks(list);
      break;
    default:
      LOGERROR("Unknown whence = %d", whence);
      list.clear();
  }

  return list.size();
}

unsigned rnr::LogBook::getFlags ( ) const

inline

Get the current formatting flags.

Returns

Bit list of or'ed flags.

Definition at line 618 of file LogBook.h.

References m_uFlags.

Referenced by mainInit().

    {
      return m_uFlags;
    }

const std::string& rnr::LogBook::getName ( ) const

inline

Get the name of the log book.

Returns

String.

Definition at line 558 of file LogBook.h.

References m_strName.

Referenced by mainInit().

    {
      return m_strName;
    }

bool rnr::LogBook::hasBookMark ( const std::string &  strMark ) const

inline

Test if bookmark exists in log book.

Parameters

strMark

Bookmark label.

Returns

Returns true or false.

Definition at line 548 of file LogBook.h.

References findMark(), and m_book.

    {
      return findMark(strMark) != m_book.end();
    }

const LogBook::Entry & LogBook::lastEntry

(

)

const

Get the last (latest) log entry.

Returns

If the entry exists, reference to the last log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Definition at line 581 of file LogBook.cxx.

References m_book, and size().

Referenced by lastText().

{
  if( size() > 0 )
  {
    return m_book[size()-1];
  }
  else
  {
    return noentry;
  }
}

const std::string& rnr::LogBook::lastText ( ) const

inline

Get the last (latest) log entry text.

Returns

If the entry exists, reference to the last log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Definition at line 523 of file LogBook.h.

References getBookMarks(), lastEntry(), and rnr::LogBook::Entry::m_strText.

Referenced by rnr::cmd::CommandLine::getErrorStr().

    {
      return lastEntry().m_strText;
    }

size_t LogBook::logEntry	(	const std::string	strText,
		const std::string	strMark = ""
	)

Log the given entry into the log book.

Any pending log entry remains untouched.

Note

The alternative method to log an entry is to use the LogBook insertion stream operators.

Parameters

strText	Log entry text.
strMark	Associated log entry bookmark. If empty (""), then no bookmark added.

Returns

Returns the new number of entries in the log book.

Definition at line 370 of file LogBook.cxx.

References FlagDebug, limitSize(), m_book, m_uFlags, m_uTotalEver, and size().

{
  if( m_uFlags & FlagDebug )
  {
    cerr << "DBG: " << __func__ << "("
      << "mark=\"" << strMark << "\", "
      << "text=\"" << strText << "\")" <<endl;
  }

  Entry  entry(strMark, strText);

  // add log entry to log book
  m_book.push_back(entry);

  ++m_uTotalEver;

  // limit log's size
  limitSize();

  return size();
}

size_t LogBook::logPending

(

)

Log any pending entry into the log book.

The pending entry and associated bookmark are recorded into log. The pending data are then erased.

Note

The alternative method to log an entry is to use the LogBook insertion stream operators.

Returns

Returns the new number of entries in the log book.

Definition at line 392 of file LogBook.cxx.

References erasePending(), FlagDebug, limitSize(), m_book, m_ssText, m_strMark, m_uFlags, m_uTotalEver, and size().

Referenced by rnr::eoe().

{
  // no pending entry
  if( m_ssText.str().empty() )
  {
    return size();
  }

  if( m_uFlags & FlagDebug )
  {
    cerr << "DBG: " << __func__ << "() "
      << "mark=\"" << m_strMark << "\", "
      << "text=\"" << m_ssText.str() << "\"" <<endl;
  }

  Entry  entry(m_strMark, m_ssText.str());

  // add pending log entry to log book
  m_book.push_back(entry);

  // erase pending
  erasePending();

  ++m_uTotalEver;

  // limit log's size
  limitSize();

  return size();
}

std::string LogBook::makeBookMarkLabel

(

)

Generate a unique bookmark label.

Returns

Label string.

Definition at line 612 of file LogBook.cxx.

References m_uTotalEver, rnr::operator<<(), and printLog().

Referenced by rnr::bookmark(), and clearFlags().

{
  stringstream ss;

  ss << "_bookmark." << m_uTotalEver << "_";

  return ss.str();
}

const size_t rnr::LogBook::max_size ( ) const

inline

Return the maximum number entries the log book can hold.

Returns

Size.

Definition at line 578 of file LogBook.h.

References m_uMaxEntries.

Referenced by mainInit().

    {
      return m_uMaxEntries;
    }

size_t rnr::LogBook::numOfTotalEver ( ) const

inline

Return the total number of entries ever added during log book's life.

Returns

Total number.

Definition at line 608 of file LogBook.h.

References m_uTotalEver.

Referenced by mainInit().

    {
      return m_uTotalEver;
    }

LogBook & LogBook::operator=

(

const LogBook &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 170 of file LogBook.cxx.

References checkLen(), copy(), limitSize(), m_book, m_ssText, m_uTotalEver, and size().

{
  copy(rhs);
  return *this;
}

const LogBook::Entry & LogBook::operator[]

(

const size_t

index

)

const

Log book array index operator.

Get the entry at the index.

Parameters

index

Log book absolute index.

Returns

If the entry exists, reference to log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

Definition at line 571 of file LogBook.cxx.

References at().

{
  return at(index);
}

const Entry& rnr::LogBook::operator[]

(

const std::string &

strMark

)

const

Log book array mark operator.

Parameters

strMark

Bookmark label.

Returns

If the entry exists, reference to log entry is returned. Otherwise, a "no entry" entry is returned (test with Entry::empty()).

unsigned rnr::LogBook::orFlags ( const unsigned  uFlags )

inline

Or new flags into the current formatting flags.

Parameters

uFlags

Flags to or into bit list of flags.

Returns

New bit list of or'ed flags.

Definition at line 643 of file LogBook.h.

References m_uFlags.

Referenced by mainInit().

    {
      m_uFlags |= uFlags;
      return m_uFlags;
    }

ostream & LogBook::printLog

(

std::ostream &

os

)

const

Print the entire log book to the output stream.

The output is controlled by the current formatting flag bits.

* LogBook
* entry_0    | ^   <-- oldest end point
* entry_1    | |
*   ...      | |
* entry_n-1  v |   <-- newest end point
*             \ \
*              \ \
*               \ reverse order
*                \
*                 forward order
* 

Parameters

os	Output stream.

Returns

Reference to output stream.

Definition at line 630 of file LogBook.cxx.

References FlagORev, m_uFlags, prt(), rprt(), and size().

Referenced by rnr::cmd::CommandLine::backtrace(), clearFlags(), and makeBookMarkLabel().

{
  // reverse order: newest to oldest
  if( m_uFlags & FlagORev )
  {
    rprt(os, 0, size() - 1);
  }
  // forward order: oldest to newest
  else
  {
    prt(os, 0, size() - 1);
  }

  return os;
}

ostream & LogBook::printToMark	(	std::ostream &	os,
		const std::string	strMark,
		int	endpt
	)		const

Print the log book entires between the bookmark and the specified end point to the output stream.

The output is controlled by the current formatting flag bits.

If the opposite end point to the mark is the oldest entry, then the bookmark entry is excluded. Otherwise it is included.

* LogBook 
* entry_0    | ^   <-- oldest end point
* entry_1    | |
*   ...      | |
* entry_k-1  v |   <-- sans mark end point
*
* entry_k    | ^   <-- mark end point
* entry_k+1  | |
*   ...      | |
* entry_n-1  v |   <-- newest end point
*             \ \
*              \ \
*               \ reverse order
*                \
*                 forward order
* 

Parameters

os	Output stream.
strMark	Bookmark search label.
endpt	Opposite end point to mark (OLDEST or NEWEST).

Returns

Reference to output stream.

Definition at line 646 of file LogBook.cxx.

References findMark(), FlagORev, m_book, m_uFlags, OLDEST, prt(), rprt(), and size().

Referenced by rnr::cmd::CommandLine::backtrace(), and clearFlags().

{
  BookCIter pos;
  size_t    indexMark;

  // no mark
  if( (pos = findMark(strMark)) == m_book.end() )
  {
    return os;
  }

  indexMark = distance(m_book.begin(), pos);

  // reverse order: newest to oldest
  if( m_uFlags & FlagORev )
  {
    if( endpt == OLDEST )
    {
      rprt(os, 0, indexMark-1);
    }
    else // NEWEST
    {
      rprt(os, indexMark, size()-1);
    }
  }

  // forward order: oldest to newest
  else
  {
    if( endpt == OLDEST )
    {
      prt(os, 0, indexMark-1);
    }
    else // NEWEST
    {
      prt(os, indexMark, size()-1);
    }
  }

  return os;
}

void LogBook::prt ( std::ostream &  os, size_t  index0, size_t  index1  ) const

protected

Print log book from index 0 to index 1, inclusive.

The output is controlled by the current formatting flag bits.

Parameters

os	Output stream.
index0	Starting log book index.
index1	Ending log book index.

Definition at line 688 of file LogBook.cxx.

References FlagDebug, FlagOMark, FlagONum, FlagOTime, m_book, m_uFlags, and size().

Referenced by printLog(), and printToMark().

{
  BookCIter iter, pos0, pos1;
  size_t    index;

  if( m_uFlags & FlagDebug )
  {
    os << "DBG: " << __func__ << "(" << index0 << ", " << index1 << ")" << endl;
  }

  if( size() == 0 )
  {
    return;
  }
  else if( (index0 > index1) || (index1 >= size()) )
  {
    return;
  }

  pos0  = m_book.begin() + index0;
  pos1  = m_book.begin() + index1;
  index = index0;

  for(iter = pos0; iter != m_book.end() && iter <= pos1; ++iter)
  {
    if( (m_uFlags & FlagOMark) && !iter->m_strMark.empty() )
    {
      os << "        ~~ " << iter->m_strMark << endl;
    }

    if( m_uFlags & FlagONum )
    {
      os << setw(3) << index << ". ";
    }

    if( m_uFlags & FlagOTime )
    {
      os << "[" << iter->m_timestamp << "] ";
    }

    os << iter->m_strText << endl;

    ++index;
  }
}

void LogBook::resize

(

size_t

uMaxEntries

)

Resize maximum size of log book.

If the new size is smaller, then entries may be deleted.

Parameters

uMaxEntries

Maximum number of entries in log book.

Definition at line 512 of file LogBook.cxx.

References limitSize(), and m_uMaxEntries.

Referenced by size().

{
  if( uMaxEntries > 0 )
  {
    m_uMaxEntries = uMaxEntries;
    limitSize();
  }
}

void LogBook::rprt ( std::ostream &  os, size_t  index0, size_t  index1  ) const

protected

Reverse print log book from index 1 to index 0, inclusive.

The output is controlled by the current formatting flag bits.

Parameters

os	Output stream.
index0	Starting log book index.
index1	Ending log book index.

Definition at line 734 of file LogBook.cxx.

References FlagDebug, FlagOMark, FlagONum, FlagOTime, m_book, m_uFlags, and size().

Referenced by printLog(), and printToMark().

{
  BookCRIter  iter, pos0, pos1;
  size_t      last;
  size_t      index;

  if( m_uFlags & FlagDebug )
  {
    os << "DBG: " << __func__ << "(" << index0 << ", " << index1 << ")" << endl;
  }

  if( size() == 0 )
  {
    return;
  }
  else if( (index0 > index1) || (index1 >= size()) )
  {
    return;
  }

  last = size() - 1;

  index  = index1;

  pos0  = m_book.rbegin() + last  - index1;
  pos1  = m_book.rbegin() + last  - index0;

  for(iter = pos0; iter != m_book.rend() && iter <= pos1; ++iter)
  {
    if( m_uFlags & FlagONum )
    {
      os << setw(3) << index << ". ";
    }

    if( m_uFlags & FlagOTime )
    {
      os << "[" << iter->m_timestamp << "] ";
    }

    os << iter->m_strText << endl;

    if( (m_uFlags & FlagOMark) && !iter->m_strMark.empty() )
    {
      os << "        ~~ " << iter->m_strMark << endl;
    }

    --index;
  }
}

void LogBook::rsortMarks ( BookMarkList &  sorted ) const

protected

Reverse sort bookmarks from newest to oldest.

Parameters

[out]

sorted

List of sorted bookmarks.

Definition at line 881 of file LogBook.cxx.

References rnr::bookmark(), clear(), FlagDebug, m_book, m_uFlags, and size().

Referenced by getBookMarks().

{
  BookCRIter  iter;
  size_t      index;
  BookMark    bookmark;

  sorted.clear();

  index = size() - 1;

  for(iter = m_book.rbegin(); iter != m_book.rend(); ++iter)
  {
    if( !iter->m_strMark.empty() )
    {
      bookmark.m_strMark  = iter->m_strMark;
      bookmark.m_index    = index;

      if( m_uFlags & FlagDebug )
      {
        cerr << "DBG: mark=\"" << bookmark.m_strMark
          << "\", index=" << bookmark.m_index << endl;
      }

      sorted.push_back(bookmark);
    }

    --index;
  }
}

unsigned rnr::LogBook::setFlags ( const unsigned  uFlags )

inline

Set the current formatting flags.

Parameters

uFlags

Flags to set.

Returns

New bit list of or'ed flags.

Definition at line 630 of file LogBook.h.

References m_uFlags.

Referenced by mainInit(), and rnr::operator<<().

    {
      m_uFlags = uFlags;
      return m_uFlags;
    }

void rnr::LogBook::setName ( const std::string &  strName )

inline

Set the name of the log book.

Parameters

strName

String.

Definition at line 568 of file LogBook.h.

References m_strName.

Referenced by mainInit().

    {
      m_strName = strName;
    }

void LogBook::setPending	(	const std::string	strText,
		const std::string	strMark
	)

Set the pending log text and associated bookmark.

Parameters

strText	Log entry text.
strMark	Associated log entry bookmark label.

Definition at line 435 of file LogBook.cxx.

References setPendingBookMark(), and setPendingText().

{
  setPendingText(strText);
  setPendingBookMark(strMark);
}

void LogBook::setPendingBookMark

(

const std::string

strMark

)

Set the pending bookmark.

The pending bookmark is associated with the pending log entry. Any previous pending, unlogged bookmark will be lost.

Note

The alternative (and preferred) method to set the pending mark is to use the LogBook insertion stream operators.

Parameters

strMark

Pending bookmark label.

Definition at line 430 of file LogBook.cxx.

References m_strMark.

Referenced by rnr::bookmark(), rnr::operator<<(), and setPending().

{
  m_strMark = strMark;
}

void LogBook::setPendingText

(

const std::string

strText

)

Set the pending log text.

Any previously pending, unlogged text will be lost.

Note

The alternative method to log an entry is to use the LogBook insertion stream operators.

Parameters

strText

Log entry text.

Definition at line 423 of file LogBook.cxx.

References m_ssText, and ssflush().

Referenced by setPending().

{
  ssflush();

  m_ssText << strText;
}

size_t rnr::LogBook::size ( ) const

inline

Return the number of logged entries in the log book.

Returns

Number of entries.

Definition at line 588 of file LogBook.h.

References m_book, and resize().

Referenced by at(), eraseEntries(), eraseToMark(), lastEntry(), logEntry(), logPending(), mainInit(), operator=(), printLog(), printToMark(), prt(), rprt(), and rsortMarks().

    {
      return (size_t)m_book.size();
    }

void LogBook::sortMarks ( BookMarkList &  sorted ) const

protected

Sort bookmarks from oldest to newest.

Parameters

[out]

sorted

List of sorted bookmarks.

Definition at line 851 of file LogBook.cxx.

References rnr::bookmark(), clear(), FlagDebug, m_book, and m_uFlags.

Referenced by getBookMarks().

{
  BookCIter iter;
  size_t    index;
  BookMark  bookmark;

  sorted.clear();

  index = 0;

  for(iter = m_book.begin(); iter != m_book.end(); ++iter)
  {
    if( !iter->m_strMark.empty() )
    {
      bookmark.m_strMark  = iter->m_strMark;
      bookmark.m_index    = index;

      if( m_uFlags & FlagDebug )
      {
        cerr << "DBG: mark=\"" << bookmark.m_strMark
          << "\", index=" << bookmark.m_index << endl;
      }

      sorted.push_back(bookmark);
    }

    ++index;
  }
}

void LogBook::ssflush ( )

protected

Flush the pending text stream.

The bytes go to a better place, not the log.

Definition at line 797 of file LogBook.cxx.

References m_bWarnThrottle, and m_ssText.

Referenced by erasePending(), erasePendingText(), and setPendingText().

{
  m_ssText.str(string());
  m_ssText.clear();
  m_bWarnThrottle = false;
}

const std::string& rnr::LogBook::textAt ( const std::string &  strMark ) const

inline

Get the entry text at the bookmark.

Parameters

strMark

Bookmark label.

Returns

If the entry exists, reference to the log entry text is returned. Otherwise, an empty string is returned.

Definition at line 482 of file LogBook.h.

References at(), and rnr::LogBook::Entry::m_strText.

Referenced by mainInit().

    {
      return at(strMark).m_strText;
    }

const std::string& rnr::LogBook::textAt ( const size_t  index ) const

inline

Get the entry text at the index.

Parameters

index

Log book absolute index.

Returns

If the entry exists, reference to the log entry text is returned. Otherwise, an empty string is returned.

Definition at line 496 of file LogBook.h.

References at(), and rnr::LogBook::Entry::m_strText.

    {
      return at(index).m_strText;
    }

const std::string& rnr::LogBook::textAt ( const size_t  index, int  whence  ) const

inline

Get the entry text at relative index from whence.

Parameters

index	Relative log book index.
whence	Whence directive (OLDEST or NEWEST).

Returns

If the entry exists, reference to the log entry text is returned. Otherwise, an empty string is returned.

Definition at line 511 of file LogBook.h.

References at(), and rnr::LogBook::Entry::m_strText.

    {
      return at(index, whence).m_strText;
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const LogBook &  log  )

friend

Stream insertion operator.

The entire log book is inserted. Formatting is controlled by the current flags settings.

Parameters

os	Output stream.
log	Log book.

Returns

Reference to output stream.

---

The documentation for this class was generated from the following files:

• include/rnr/appkit/LogBook.h
• sw/librnr_appkit/LogBook.cxx