BOL::CommentedTextParser Class Reference

#include <CommentedTextParser.hpp>

Detailed Description

Definition at line 27 of file CommentedTextParser.hpp.

Public Member Functions
bool	atEndOfFile ()
CommentedTextParser &	closeFile ()
	CommentedTextParser (std::string const &commentMarker, bool const isVerbose)
	CommentedTextParser (VectorlikeArray< std::string > const &commentMarkerSet, bool const isVerbose)
bool	openFile (std::string const &fileName)
bool	parseNextLineOfFile (std::string &stringForData, std::string &stringForComment)
VectorlikeArray< std::pair< std::string, std::string > > const &	parseString (std::string const &textToParse)
bool	readJustNextValidLine (std::string &stringToFill)
bool	readNextNonEmptyLineOfFileWithoutComment (std::string &stringToFill)
virtual	~CommentedTextParser ()

Protected Member Functions
bool	readInNextLine ()
void	reportStateOfFile ()

Protected Attributes
VectorlikeArray< std::string >	commentMarkerSet
std::ifstream	inputFile
bool const	isVerbose
std::string	lineBeingRead
bool	linesOfFileRemain
std::pair< std::string, std::string >	parsedLine
VectorlikeArray< std::pair< std::string, std::string > >	parsedText
VectorlikeArray< std::string >	textAsLines

Static Protected Attributes
static std::string const	trimmingChars

Constructor & Destructor Documentation

CommentedTextParser() [1/2]

BOL::CommentedTextParser::CommentedTextParser	(	std::string const &	commentMarker,
		bool const	isVerbose
	)

Definition at line 19 of file CommentedTextParser.cpp.

                                                                   :
      isVerbose( isVerbose ),
      commentMarkerSet( 1 ),
      parsedText(),
      parsedLine( "",
                  "" ),
      textAsLines(),
      lineBeingRead( "" ),
      linesOfFileRemain( false ),
      inputFile()
  {
    commentMarkerSet.getFront().assign( commentMarker );
  }

CommentedTextParser() [2/2]

BOL::CommentedTextParser::CommentedTextParser	(	VectorlikeArray< std::string > const &	commentMarkerSet,
		bool const	isVerbose
	)

Definition at line 34 of file CommentedTextParser.cpp.

                                                                   :
      isVerbose( isVerbose ),
      commentMarkerSet( commentMarkerSet ),
      parsedText(),
      parsedLine( "",
                  "" ),
      textAsLines(),
      lineBeingRead( "" ),
      linesOfFileRemain( false ),
      inputFile()
  {
    // just an initialization list.
  }

~CommentedTextParser()

BOL::CommentedTextParser::~CommentedTextParser ( )

virtual

Definition at line 50 of file CommentedTextParser.cpp.

  {
    if( inputFile.is_open() )
    {
      inputFile.close();
    }
  }

Member Function Documentation

atEndOfFile()

bool BOL::CommentedTextParser::atEndOfFile ( )

inline

Definition at line 175 of file CommentedTextParser.hpp.

  {
    return !linesOfFileRemain;
  }

closeFile()

CommentedTextParser & BOL::CommentedTextParser::closeFile ( )

inline

Definition at line 183 of file CommentedTextParser.hpp.

  {
    linesOfFileRemain = false;
    if( inputFile.is_open() )
    {
      inputFile.close();
    }
    return *this;
  }

openFile()

bool BOL::CommentedTextParser::openFile ( std::string const &  fileName )

inline

Definition at line 146 of file CommentedTextParser.hpp.

  {
    closeFile();
    // this sets notYetAtEndOfFile to false & also closes inputFile if it was
    // open.
    inputFile.open( fileName.c_str() );
    if( inputFile.is_open()
        &&
        !(inputFile.eof()) )
    {
      linesOfFileRemain = true;
    }
    else
    {
      std::cout
      << std::endl
      << "BOL::error! CommentedTextParser tried to open "
      << fileName << " but could not (or " << fileName << " is empty)!";
      std::cout << std::endl;
      linesOfFileRemain = false;
    }
    return linesOfFileRemain;
  }

parseNextLineOfFile()

bool BOL::CommentedTextParser::parseNextLineOfFile ( std::string &  stringForData, std::string &  stringForComment  )

inline

Definition at line 194 of file CommentedTextParser.hpp.

  {
    if( readInNextLine() )
    {
      stringForData.assign( BOL::StringParser::substringToFirst(
                                BOL::StringParser::trimFromBack( lineBeingRead,
                                             BOL::StringParser::newlineChars ),
                                                              commentMarkerSet,
                                                         &stringForComment ) );
      /* this puts all of the line just read before the comment marker into
       * stringForData & the remainder into stringForComment (including the
       * comment characters).
       */
      BOL::StringParser::trimFromBack( stringForData,
                                       BOL::StringParser::newlineChars );
      return true;
    }
    else
    {
      return false;
    }
  }

parseString()

VectorlikeArray< std::pair< std::string, std::string > > const & BOL::CommentedTextParser::parseString ( std::string const &  textToParse )

inline

Definition at line 115 of file CommentedTextParser.hpp.

  {
    BOL::StringParser::parseByChar( textToParse,
                                    textAsLines,
                                    BOL::StringParser::newlineChars );
    // now textAsLines is textToParse broken up into strings corresponding to
    // each line of textToParse. parsedText has to fit all of textAsLines:
    parsedText.setSize( textAsLines.getSize() );
    for( int lineIndex( textAsLines.getLastIndex() );
         0 <= lineIndex;
         --lineIndex )
    {
      parsedText[ lineIndex ].first.assign(
                 BOL::StringParser::substringToFirst( textAsLines[ lineIndex ],
                                                      commentMarkerSet,
                                         &(parsedText[ lineIndex ].second) ) );
      /* this puts all of textAsLines[ lineIndex ] before the comment marker
       * into parsedText[ lineIndex ].first & the remainder into
       * parsedText[ lineIndex ].second (including the comment characters).
       */
    }
    return parsedText;
  }

readInNextLine()

bool BOL::CommentedTextParser::readInNextLine ( )

inlineprotected

Definition at line 257 of file CommentedTextParser.hpp.

  {
    if( linesOfFileRemain )
    {
      std::getline( inputFile,
                    lineBeingRead );
      linesOfFileRemain = inputFile.good();
      if( !linesOfFileRemain
          &&
          isVerbose )
      {
        reportStateOfFile();
      }
      return true;
    }
    else
    {
      return false;
    }
  }

readJustNextValidLine()

bool BOL::CommentedTextParser::readJustNextValidLine ( std::string &  stringToFill )

inline

Definition at line 77 of file CommentedTextParser.hpp.

    { return readNextNonEmptyLineOfFileWithoutComment( stringToFill ); }

readNextNonEmptyLineOfFileWithoutComment()

bool BOL::CommentedTextParser::readNextNonEmptyLineOfFileWithoutComment ( std::string &  stringToFill )

inline

Definition at line 225 of file CommentedTextParser.hpp.

  {
    stringToFill.clear();
    while( stringToFill.empty()
           &&
           readInNextLine() )
      // the order of these conditionals is important: it has to check if it
      // needs to read in the next line before it tries to read it in!
    {
      stringToFill.assign( BOL::StringParser::substringToFirst( lineBeingRead,
                                                          commentMarkerSet ) );
      /* this puts all of the line just read before the comment marker into
       * stringToFill & throws away the remainder. now all trimmingChars chars
       * are trimmed from the front & back of stringToFill:
       */
      stringToFill.assign( BOL::StringParser::trimFromFrontAndBack(
                                                                  stringToFill,
                                                             trimmingChars ) );
    }
    // now either stringToFill is not empty, or inputFile ran out of lines.
    return !(stringToFill.empty());
  }

reportStateOfFile()

void BOL::CommentedTextParser::reportStateOfFile ( )

inlineprotected

Definition at line 285 of file CommentedTextParser.hpp.

  {
    if( inputFile.eof() )
      // if reading in this line brought inputFile to its end, note that.
    {
      std::cout
      << std::endl
      << "BOL::CommentedTextParser reached the end of the file.";
      std::cout << std::endl;
    }
    else
    {
      std::cout
      << std::endl
      << "BOL::CommentedTextParser cannot read in any more of the file after"
      << " a bad reading operation.";
      std::cout << std::endl;
    }
  }

Member Data Documentation

commentMarkerSet

VectorlikeArray< std::string > BOL::CommentedTextParser::commentMarkerSet

protected

Definition at line 87 of file CommentedTextParser.hpp.

inputFile

std::ifstream BOL::CommentedTextParser::inputFile

protected

Definition at line 95 of file CommentedTextParser.hpp.

isVerbose

bool const BOL::CommentedTextParser::isVerbose

protected

Definition at line 86 of file CommentedTextParser.hpp.

lineBeingRead

std::string BOL::CommentedTextParser::lineBeingRead

protected

Definition at line 91 of file CommentedTextParser.hpp.

linesOfFileRemain

bool BOL::CommentedTextParser::linesOfFileRemain

protected

Definition at line 92 of file CommentedTextParser.hpp.

parsedLine

std::pair< std::string, std::string > BOL::CommentedTextParser::parsedLine

protected

Definition at line 89 of file CommentedTextParser.hpp.

parsedText

VectorlikeArray< std::pair< std::string, std::string > > BOL::CommentedTextParser::parsedText

protected

Definition at line 88 of file CommentedTextParser.hpp.

textAsLines

VectorlikeArray< std::string > BOL::CommentedTextParser::textAsLines

protected

Definition at line 90 of file CommentedTextParser.hpp.

trimmingChars

std::string const BOL::CommentedTextParser::trimmingChars

staticprotected

Definition at line 84 of file CommentedTextParser.hpp.

---

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

• CommentedTextParser.hpp
• CommentedTextParser.cpp