TSsParserMP Class Reference

#include <ssmp.h>

Public Member Functions
	TSsParserMP (const TStr &FNm, const TSsFmt _SsFmt=ssfTabSep, const bool &_SkipLeadBlanks=false, const bool &_SkipCmt=true, const bool &_SkipEmptyFld=false)
	Constructor. More...
	TSsParserMP (const TStr &FNm, const char &Separator, const bool &_SkipLeadBlanks=false, const bool &_SkipCmt=true, const bool &_SkipEmptyFld=false)
	Constructor. More...
	~TSsParserMP ()
bool	Next ()
	Loads next line from the input file. More...
bool	NextSlow ()
	Loads next line from the input file (older, slow implementation - deprecated). More...
int	Len () const
	Returns the number of fields in the current line. More...
int	GetFlds () const
	Returns the number of fields in the current line. More...
uint64	GetLineNo () const
	Returns the line number of the current line. More...
bool	IsCmt () const
	Checks whether the current line is a comment (starts with '#'). More...
void	SkipCommentLines ()
	Skips lines that begin with a comment character. More...
bool	Eof () const
	Checks for end of file. More...
TChA	GetLnStr () const
	Returns the current line. More...
void	ToLc ()
	Transforms the current line to lower case. More...
const char *	GetFld (const int &FldN) const
	Returns the contents of the field at index FldN. More...
char *	GetFld (const int &FldN)
	Returns the contents of the field at index FldN. More...
const char *	operator[] (const int &FldN) const
	Returns the contents of the field at index FldN. More...
char *	operator[] (const int &FldN)
	Returns the contents of the field at index FldN. More...
bool	GetInt (const int &FldN, int &Val) const
	If the field FldN is an integer its value is returned in Val and the function returns true. More...
int	GetInt (const int &FldN) const
	Assumes FldN is an integer its value is returned. If FldN is not an integer an exception is thrown. More...
bool	IsInt (const int &FldN) const
	Checks whether fields FldN is an integer. More...
bool	GetFlt (const int &FldN, double &Val) const
	If the field FldN is a float its value is returned in Val and the function returns true. More...
bool	IsFlt (const int &FldN) const
	Checks whether fields FldN is a float. More...
double	GetFlt (const int &FldN) const
	Assumes FldN is a floating point number its value is returned. If FldN is not an integer an exception is thrown. More...
uint64	GetStreamPos () const
	Returns position of stream pointer. More...
uint64	GetStreamLen () const
	Returns length of stream. More...
void	SetStreamPos (uint64 Pos)
	Sets position of stream pointer. More...
uint64	CountNewLinesInRange (uint64 Lb, uint64 Ub) const
	Counts number of occurences of ' ' in [Lb, Ub) More...
TVec< uint64 >	GetStartPosV (uint64 Lb, uint64 Ub) const
	Finds start positions of all lines ending somewhere in [Lb, Ub) More...
void	NextFromIndex (uint64 Index, TVec< char * > &FieldsV)
	Loads next line starting from a given position. More...
int	GetIntFromFldV (TVec< char * > &FieldsV, const int &FldN)
	Gets integer at field FldN. More...
double	GetFltFromFldV (TVec< char * > &FieldsV, const int &FldN)
	Gets float at field FldN. More...
const char *	DumpStr () const

Static Public Member Functions
static PSsParserMP	New (const TStr &FNm, const TSsFmt SsFmt)

Private Member Functions
	UndefDefaultCopyAssign (TSsParserMP)

Private Attributes
TCRef	CRef
TSsFmt	SsFmt
	Separator type. More...
bool	SkipLeadBlanks
	Ignore leading whitespace characters in a line. More...
bool	SkipCmt
	Skip comments (lines starting with #). More...
bool	SkipEmptyFld
	Skip empty fields (i.e., multiple consecutive separators are considered as one). More...
uint64	LineCnt
	Number of processed lines so far. More...
char	SplitCh
	Separator character (if one of the non-started separators is used) More...
TChA	LineStr
	Current line. More...
TVec< char * >	FldV
	Pointers to fields of the current line. More...
TPt< TMIn >	FInPt
	Pointer to the input file stream. More...

Friends
class	TPt< TSsParserMP >

Detailed Description

Definition at line 7 of file ssmp.h.

Constructor & Destructor Documentation

TSsParserMP::TSsParserMP	(	const TStr &	FNm,
		const TSsFmt	_SsFmt = ssfTabSep,
		const bool &	_SkipLeadBlanks = false,
		const bool &	_SkipCmt = true,
		const bool &	_SkipEmptyFld = false
	)

Constructor.

Parameters

FNm	Input filename. Can be a text file or a compressed file.
_SsFmt	Spread-sheet separator format. Each line will be broken in a set of fields, where the boundary between the fields is defined by the _SsFmt.
_SkipLeadBlanks	If true leading/trailing white-spaces of the line will be ignored.
_SkipCmt	If true lines starting with '#' will be considered as comments and will be skipped.
_SkipEmptyFld	If true then empty fields (consecutive occurrences of the separator) will be ignored.

TSsParserMP::TSsParserMP	(	const TStr &	FNm,
		const char &	Separator,
		const bool &	_SkipLeadBlanks = false,
		const bool &	_SkipCmt = true,
		const bool &	_SkipEmptyFld = false
	)

Constructor.

Parameters

FNm	Input filename. Can be a text file or a compressed file.
Separator	Spread-sheet separator character. Each line will be broken in a set of fields, where the boundary between the fields is the Separator character.
_SkipLeadBlanks	If true leading/trailing white-spaces of the line will be ignored.
_SkipCmt	If true lines starting with '#' will be considered as comments and will be skipped.
_SkipEmptyFld	If true then empty fields (consecutive occurrences of the separator) will be ignored.

Definition at line 3 of file ssmp.cpp.

                                                                                                                                             : SsFmt(ssfSpaceSep), 
 SkipLeadBlanks(_SkipLeadBlanks), SkipCmt(_SkipCmt), SkipEmptyFld(_SkipEmptyFld), LineCnt(0), /*Bf(NULL),*/ SplitCh('\t'), LineStr(), FldV(), FInPt(NULL) {
  FInPt = TMIn::New(FNm, true);
  SplitCh = Separator;
}

TSsParserMP::~TSsParserMP

(

)

Definition at line 9 of file ssmp.cpp.

                          {
}

Member Function Documentation

uint64 TSsParserMP::CountNewLinesInRange	(	uint64	Lb,
		uint64	Ub
	)		const

Counts number of occurences of '
' in [Lb, Ub)

Definition at line 102 of file ssmp.cpp.

                                                                   {
  return FInPt->CountNewLinesInRange(Lb, Ub);
}

const char * TSsParserMP::DumpStr

(

)

const

Definition at line 91 of file ssmp.cpp.

                                       {
  static TChA ChA(10*1024);
  ChA.Clr();
  for (int i = 0; i < FldV.Len(); i++) {
    ChA += TStr::Fmt("  %d: '%s'\n", i, FldV[i]);
  }
  return ChA.CStr();
}

bool TSsParserMP::Eof ( ) const

inline

Checks for end of file.

Definition at line 59 of file ssmp.h.

{ return FInPt->Eof(); }

const char* TSsParserMP::GetFld ( const int &  FldN ) const

inline

Returns the contents of the field at index FldN.

Definition at line 66 of file ssmp.h.

{ return FldV[FldN]; }

char* TSsParserMP::GetFld ( const int &  FldN )

inline

Returns the contents of the field at index FldN.

Definition at line 68 of file ssmp.h.

{ return FldV[FldN]; }

int TSsParserMP::GetFlds ( ) const

inline

Returns the number of fields in the current line.

Definition at line 51 of file ssmp.h.

{ return Len(); }

bool TSsParserMP::GetFlt	(	const int &	FldN,
		double &	Val
	)		const

If the field FldN is a float its value is returned in Val and the function returns true.

Definition at line 69 of file ssmp.cpp.

                                                           {
  // parsing format {ws} [+/-] +{d} ([.]{d}) ([E|e] [+/-] +{d})
  const char *c = GetFld(FldN);
  while (TCh::IsWs(*c)) { c++; }
  if (*c=='+' || *c=='-') { c++; }
  if (! TCh::IsNum(*c) && *c!='.') { return false; }
  while (TCh::IsNum(*c)) { c++; }
  if (*c == '.') {
    c++;
    while (TCh::IsNum(*c)) { c++; }
  }
  if (*c=='e' || *c == 'E') {
    c++;
    if (*c == '+' || *c == '-' ) { c++; }
    if (! TCh::IsNum(*c)) { return false; }
    while (TCh::IsNum(*c)) { c++; }
  }
  if (*c != 0) { return false; }
  Val = atof(GetFld(FldN));
  return true;
}

double TSsParserMP::GetFlt ( const int &  FldN ) const

inline

Assumes FldN is a floating point number its value is returned. If FldN is not an integer an exception is thrown.

Definition at line 85 of file ssmp.h.

                                       {
    double Val=0.0; IAssert(GetFlt(FldN, Val)); return Val; }

double TSsParserMP::GetFltFromFldV	(	TVec< char * > &	FieldsV,
		const int &	FldN
	)

Gets float at field FldN.

Definition at line 170 of file ssmp.cpp.

                                                                        {
  // parsing format {ws} [+/-] +{d} ([.]{d}) ([E|e] [+/-] +{d})
  const char *c = FieldsV[FldN];
  /* skip whitespace at the beginning */
  while (TCh::IsWs(*c)) { c++; }
  /* skip the sign */
  if (*c=='+' || *c=='-') { c++; }
  /* error, if not a digit or '.' */
  if (! TCh::IsNum(*c) && *c!='.') { return -1; }
  /* skip digits */
  while (TCh::IsNum(*c)) { c++; }
  if (*c == '.') {
    c++;
    while (TCh::IsNum(*c)) { c++; }
  }
  /* skip exponent */
  if (*c=='e' || *c == 'E') {
    c++;
    if (*c == '+' || *c == '-' ) { c++; }
    if (! TCh::IsNum(*c)) { return -1; }
    while (TCh::IsNum(*c)) { c++; }
  }
  if (*c != 0  &&  !TCh::IsWs(*c)) { return -1; }
  return atof(FieldsV[FldN]);
}

bool TSsParserMP::GetInt	(	const int &	FldN,
		int &	Val
	)		const

If the field FldN is an integer its value is returned in Val and the function returns true.

Definition at line 50 of file ssmp.cpp.

                                                        {
  // parsing format {ws} [+/-] +{ddd}
  int _Val = -1;
  bool Minus=false;
  const char *c = GetFld(FldN);
  while (TCh::IsWs(*c)) { c++; }
  if (*c=='-') { Minus=true; c++; }
  if (! TCh::IsNum(*c)) { return false; }
  _Val = TCh::GetNum(*c);  c++;
  while (TCh::IsNum(*c)){ 
    _Val = 10 * _Val + TCh::GetNum(*c); 
    c++; 
  }
  if (Minus) { _Val = -_Val; }
  if (*c != 0) { return false; }
  Val = _Val;
  return true;
}

int TSsParserMP::GetInt ( const int &  FldN ) const

inline

Assumes FldN is an integer its value is returned. If FldN is not an integer an exception is thrown.

Definition at line 76 of file ssmp.h.

                                    {
    int Val=0; IAssertR(GetInt(FldN, Val), TStr::Fmt("Field %d not INT.\n%s", FldN, DumpStr()).CStr()); return Val; }

int TSsParserMP::GetIntFromFldV	(	TVec< char * > &	FieldsV,
		const int &	FldN
	)

Gets integer at field FldN.

Definition at line 152 of file ssmp.cpp.

                                                                     {
  // parsing format {ws} [+/-] +{ddd}
  int _Val = -1;
  bool Minus=false;
  const char *c = FieldsV[FldN];
  while (TCh::IsWs(*c)) { c++; }
  if (*c=='-') { Minus=true; c++; }
  if (! TCh::IsNum(*c)) { return -1; }
  _Val = TCh::GetNum(*c);  c++;
  while (TCh::IsNum(*c)){ 
    _Val = 10 * _Val + TCh::GetNum(*c); 
    c++; 
  }
  if (Minus) { _Val = -_Val; }
  if (*c != 0  &&  !TCh::IsWs(*c)) { return -1; }
  return _Val;
}

uint64 TSsParserMP::GetLineNo ( ) const

inline

Returns the line number of the current line.

Definition at line 53 of file ssmp.h.

{ return LineCnt; }

TChA TSsParserMP::GetLnStr ( ) const

inline

Returns the current line.

Definition at line 61 of file ssmp.h.

{ TChA LnOut;  for (int i = 0; i < Len(); i++) { LnOut+=GetFld(i); LnOut+=' '; }  if (LnOut.Len() > 0) LnOut.DelLastCh();  return LnOut; }

TVec< uint64 > TSsParserMP::GetStartPosV	(	uint64	Lb,
		uint64	Ub
	)		const

Finds start positions of all lines ending somewhere in [Lb, Ub)

Definition at line 106 of file ssmp.cpp.

                                                                 {
  TVec<uint64> Ret;
  if (Lb >= GetStreamLen()) {
    return Ret;
  }
  while (Lb < Ub) {
    // Find line corresponding to Lb
    uint64 StartPos = FInPt->GetLineStartPos(Lb);
    uint64 EndPos = FInPt->GetLineEndPos(Lb);

    // If line ends in given range, add to count
    if (Lb <= EndPos && EndPos < Ub) {
      Ret.Add(StartPos);
    }
    // Start at next line
    Lb = EndPos + 1;
  }
  return Ret;
}

uint64 TSsParserMP::GetStreamLen ( ) const

inline

Returns length of stream.

Definition at line 93 of file ssmp.h.

                              {
    return FInPt->GetBfL(); }

uint64 TSsParserMP::GetStreamPos ( ) const

inline

Returns position of stream pointer.

Definition at line 89 of file ssmp.h.

                              {
    return FInPt->GetBfC(); }

bool TSsParserMP::IsCmt ( ) const

inline

Checks whether the current line is a comment (starts with '#').

Definition at line 55 of file ssmp.h.

{ return Len()>0 && GetFld(0)[0] == '#'; }

bool TSsParserMP::IsFlt ( const int &  FldN ) const

inline

Checks whether fields FldN is a float.

Definition at line 83 of file ssmp.h.

{ double v; return GetFlt(FldN, v); }

bool TSsParserMP::IsInt ( const int &  FldN ) const

inline

Checks whether fields FldN is an integer.

Definition at line 79 of file ssmp.h.

{ int v; return GetInt(FldN, v); }

int TSsParserMP::Len ( ) const

inline

Returns the number of fields in the current line.

Definition at line 49 of file ssmp.h.

{ return FldV.Len(); }

static PSsParserMP TSsParserMP::New ( const TStr &  FNm, const TSsFmt  SsFmt  )

inlinestatic

Definition at line 37 of file ssmp.h.

{ return new TSsParserMP(FNm, SsFmt); }

bool TSsParserMP::Next

(

)

Loads next line from the input file.

If end of file is reached, return value is false.

Definition at line 17 of file ssmp.cpp.

                       { // split on SplitCh
  FldV.Clr(false);
  LineStr.Clr();
  FldV.Clr();
  LineCnt++;
  if (! FInPt->GetNextLnBf(LineStr)) { return false; }
  if (SkipCmt && !LineStr.Empty() && LineStr[0]=='#') { return Next(); }

  char* cur = LineStr.CStr();
  if (SkipLeadBlanks) { // skip leading blanks
    while (*cur && TCh::IsWs(*cur)) { cur++; }
  }
  char *last = cur;
  while (*cur) {
    if (SsFmt == ssfWhiteSep) { while (*cur && ! TCh::IsWs(*cur)) { cur++; } } 
    else { while (*cur && *cur!=SplitCh) { cur++; } }
    if (*cur == 0) { break; }
    *cur = 0;  cur++;
    FldV.Add(last);  last = cur;
    if (SkipEmptyFld && strlen(FldV.Last())==0) { FldV.DelLast(); } // skip empty fields
  }
  FldV.Add(last);  // add last field
  if (SkipEmptyFld && FldV.Empty()) { return Next(); } // skip empty lines
  return true; 
}

void TSsParserMP::NextFromIndex	(	uint64	Index,
		TVec< char * > &	FieldsV
	)

Loads next line starting from a given position.

Definition at line 128 of file ssmp.cpp.

{ 
  // split on SplitCh
  FieldsV.Clr();

  char* cur = FInPt->GetLine(Index);

  if (SkipLeadBlanks) { // skip leading blanks
    while (*cur && TCh::IsWs(*cur)) { cur++; }
  }
  char *last = cur;
  while (*cur != 0 && *cur != '\n') {
    if (SsFmt == ssfWhiteSep) { while (*cur && (*cur != '\n') && ! TCh::IsWs(*cur)) { cur++; } } 
    else { while (*cur && *cur!=SplitCh && (*cur != '\n')) { cur++; } }
    if (*cur == 0) { break; }
    if (*cur == '\n') { break; }
    //*cur = 0;  
    cur++;
    FieldsV.Add(last);  last = cur;
    if (SkipEmptyFld && strlen(FieldsV.Last())==0) { FieldsV.DelLast(); } // skip empty fields
  }
  FieldsV.Add(last);  // add last field
}

bool TSsParserMP::NextSlow

(

)

Loads next line from the input file (older, slow implementation - deprecated).

If end of file is reached, return value is false. This function is deprecated, use Next instead.

const char* TSsParserMP::operator[] ( const int &  FldN ) const

inline

Returns the contents of the field at index FldN.

Definition at line 70 of file ssmp.h.

{ return FldV[FldN]; }

char* TSsParserMP::operator[] ( const int &  FldN )

inline

Returns the contents of the field at index FldN.

Definition at line 72 of file ssmp.h.

{ return FldV[FldN]; }

void TSsParserMP::SetStreamPos ( uint64  Pos )

inline

Sets position of stream pointer.

Definition at line 97 of file ssmp.h.

                                {
    return FInPt->SetBfC(Pos); }

void TSsParserMP::SkipCommentLines

(

)

Skips lines that begin with a comment character.

Definition at line 12 of file ssmp.cpp.

                                   {
  FInPt->SkipCommentLines();
}

void TSsParserMP::ToLc

(

)

Transforms the current line to lower case.

Definition at line 43 of file ssmp.cpp.

                       {
  for (int f = 0; f < FldV.Len(); f++) {
    for (char *c = FldV[f]; *c; c++) {
      *c = tolower(*c); }
  }
}

TSsParserMP::UndefDefaultCopyAssign ( TSsParserMP  )

private

Friends And Related Function Documentation

friend class TPt< TSsParserMP >

friend

Definition at line 7 of file ssmp.h.

Member Data Documentation

TCRef TSsParserMP::CRef

private

Definition at line 7 of file ssmp.h.

TPt<TMIn> TSsParserMP::FInPt

private

Pointer to the input file stream.

Definition at line 17 of file ssmp.h.

TVec<char*> TSsParserMP::FldV

private

Pointers to fields of the current line.

Definition at line 16 of file ssmp.h.

uint64 TSsParserMP::LineCnt

private

Number of processed lines so far.

Definition at line 13 of file ssmp.h.

TChA TSsParserMP::LineStr

private

Current line.

Definition at line 15 of file ssmp.h.

bool TSsParserMP::SkipCmt

private

Skip comments (lines starting with #).

Definition at line 11 of file ssmp.h.

bool TSsParserMP::SkipEmptyFld

private

Skip empty fields (i.e., multiple consecutive separators are considered as one).

Definition at line 12 of file ssmp.h.

bool TSsParserMP::SkipLeadBlanks

private

Ignore leading whitespace characters in a line.

Definition at line 10 of file ssmp.h.

char TSsParserMP::SplitCh

private

Separator character (if one of the non-started separators is used)

Definition at line 14 of file ssmp.h.

TSsFmt TSsParserMP::SsFmt

private

Separator type.

Definition at line 9 of file ssmp.h.

---

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

• glib-core/ssmp.h
• glib-core/ssmp.cpp