TSsParser Class Reference

#include <ss.h>

Public Member Functions
	TSsParser (const TStr &FNm, const TSsFmt _SsFmt=ssfTabSep, const bool &_SkipLeadBlanks=false, const bool &_SkipCmt=true, const bool &_SkipEmptyFld=false)
	Constructor. More...
	TSsParser (const TStr &FNm, const char &Separator, const bool &_SkipLeadBlanks=false, const bool &_SkipCmt=true, const bool &_SkipEmptyFld=false)
	Constructor. More...
	~TSsParser ()
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...
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...
bool	GetUInt64 (const int &FldN, uint64 &Val) const
	If the field FldN is a 64-bit unsigned integer its value is returned in Val and the function returns true. More...
bool	IsUInt64 (const int &FldN) const
	Checks whether fields FldN is unsigned 64-bit integer number. More...
uint64	GetUInt64 (const int &FldN) const
	Assumes FldN is a 64-bit unsigned integer point number its value is returned. If FldN is not a 64-bit unsigned integer an exception is thrown. More...
const char *	DumpStr () const

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

Private Member Functions
	UndefDefaultCopyAssign (TSsParser)

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...
PSIn	FInPt
	Pointer to the input file stream. More...

Friends
class	TPt< TSsParser >

Detailed Description

Definition at line 72 of file ss.h.

Constructor & Destructor Documentation

TSsParser::TSsParser	(	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.

Definition at line 351 of file ss.cpp.

                                                                                                                                       : SsFmt(_SsFmt), 
 SkipLeadBlanks(_SkipLeadBlanks), SkipCmt(_SkipCmt), SkipEmptyFld(_SkipEmptyFld), LineCnt(0), /*Bf(NULL),*/ SplitCh('\t'), LineStr(), FldV(), FInPt(NULL) {
  if (TZipIn::IsZipExt(FNm.GetFExt())) { FInPt = TZipIn::New(FNm); }
  else { FInPt = TFIn::New(FNm); }
  //Bf = new char [BfLen];
  switch(SsFmt) {
    case ssfTabSep : SplitCh = '\t'; break;
    case ssfCommaSep : SplitCh = ','; break;
    case ssfSemicolonSep : SplitCh = ';'; break;
    case ssfVBar : SplitCh = '|'; break;
    case ssfSpaceSep : SplitCh = ' '; break;
    case ssfWhiteSep: SplitCh = ' '; break;
    default: FailR("Unknown separator character.");
  }
}

TSsParser::TSsParser	(	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 367 of file ss.cpp.

                                                                                                                                         : SsFmt(ssfSpaceSep), 
 SkipLeadBlanks(_SkipLeadBlanks), SkipCmt(_SkipCmt), SkipEmptyFld(_SkipEmptyFld), LineCnt(0), /*Bf(NULL),*/ SplitCh('\t'), LineStr(), FldV(), FInPt(NULL) {
  if (TZipIn::IsZipExt(FNm.GetFExt())) { FInPt = TZipIn::New(FNm); }
  else { FInPt = TFIn::New(FNm); }
  SplitCh = Separator;
}

TSsParser::~TSsParser

(

)

Definition at line 374 of file ss.cpp.

                      {
  //if (Bf != NULL) { delete [] Bf; }
}

Member Function Documentation

const char * TSsParser::DumpStr

(

)

const

Definition at line 508 of file ss.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 TSsParser::Eof ( ) const

inline

Checks for end of file.

Definition at line 122 of file ss.h.

{ return FInPt->Eof(); }

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

inline

Returns the contents of the field at index FldN.

Definition at line 129 of file ss.h.

{ return FldV[FldN]; }

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

inline

Returns the contents of the field at index FldN.

Definition at line 131 of file ss.h.

{ return FldV[FldN]; }

int TSsParser::GetFlds ( ) const

inline

Returns the number of fields in the current line.

Definition at line 116 of file ss.h.

{ return Len(); }

bool TSsParser::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 485 of file ss.cpp.

                                                         {
  // parsing format {ws} [+/-] +{d} ([.]{d}) ([E|e] [+/-] +{d})
  if (FldN >= Len()) { return false; }
  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 TSsParser::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 150 of file ss.h.

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

bool TSsParser::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 447 of file ss.cpp.

                                                      {
  // parsing format {ws} [+/-] +{ddd}
  if (FldN >= Len()) { return false; }
  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 TSsParser::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 140 of file ss.h.

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

uint64 TSsParser::GetLineNo ( ) const

inline

Returns the line number of the current line.

Definition at line 118 of file ss.h.

{ return LineCnt; }

TChA TSsParser::GetLnStr ( ) const

inline

Returns the current line.

Definition at line 124 of file ss.h.

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

bool TSsParser::GetUInt64	(	const int &	FldN,
		uint64 &	Val
	)		const

If the field FldN is a 64-bit unsigned integer its value is returned in Val and the function returns true.

Definition at line 467 of file ss.cpp.

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

uint64 TSsParser::GetUInt64 ( const int &  FldN ) const

inline

Assumes FldN is a 64-bit unsigned integer point number its value is returned. If FldN is not a 64-bit unsigned integer an exception is thrown.

Definition at line 157 of file ss.h.

{ uint64 Val=0; IAssert(GetUInt64(FldN, Val)); return Val; }

bool TSsParser::IsCmt ( ) const

inline

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

Definition at line 120 of file ss.h.

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

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

inline

Checks whether fields FldN is a float.

Definition at line 148 of file ss.h.

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

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

inline

Checks whether fields FldN is an integer.

Definition at line 143 of file ss.h.

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

bool TSsParser::IsUInt64 ( const int &  FldN ) const

inline

Checks whether fields FldN is unsigned 64-bit integer number.

Definition at line 155 of file ss.h.

{ uint64 v; return GetUInt64(FldN, v); }

int TSsParser::Len ( ) const

inline

Returns the number of fields in the current line.

Definition at line 114 of file ss.h.

{ return FldV.Len(); }

static PSsParser TSsParser::New ( const TStr &  FNm, const TSsFmt  SsFmt  )

inlinestatic

Definition at line 102 of file ss.h.

{ return new TSsParser(FNm, SsFmt); }

bool TSsParser::Next

(

)

Loads next line from the input file.

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

Definition at line 412 of file ss.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
  }

  if (*last != 0) { FldV.Add(last); }  // add last field
  if (SkipEmptyFld && FldV.Empty()) { return Next(); } // skip empty lines

  return true; 
}

bool TSsParser::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.

Definition at line 382 of file ss.cpp.

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

  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
  }

  if (*last != 0) { FldV.Add(last); }  // add last field
  if (SkipEmptyFld && FldV.Empty()) { return NextSlow(); } // skip empty lines

  return true; 
}

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

inline

Returns the contents of the field at index FldN.

Definition at line 133 of file ss.h.

{ return FldV[FldN]; }

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

inline

Returns the contents of the field at index FldN.

Definition at line 135 of file ss.h.

{ return FldV[FldN]; }

void TSsParser::ToLc

(

)

Transforms the current line to lower case.

Definition at line 440 of file ss.cpp.

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

TSsParser::UndefDefaultCopyAssign ( TSsParser  )

private

Friends And Related Function Documentation

friend class TPt< TSsParser >

friend

Definition at line 72 of file ss.h.

Member Data Documentation

TCRef TSsParser::CRef

private

Definition at line 72 of file ss.h.

PSIn TSsParser::FInPt

private

Pointer to the input file stream.

Definition at line 82 of file ss.h.

TVec<char*> TSsParser::FldV

private

Pointers to fields of the current line.

Definition at line 81 of file ss.h.

uint64 TSsParser::LineCnt

private

Number of processed lines so far.

Definition at line 78 of file ss.h.

TChA TSsParser::LineStr

private

Current line.

Definition at line 80 of file ss.h.

bool TSsParser::SkipCmt

private

Skip comments (lines starting with #).

Definition at line 76 of file ss.h.

bool TSsParser::SkipEmptyFld

private

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

Definition at line 77 of file ss.h.

bool TSsParser::SkipLeadBlanks

private

Ignore leading whitespace characters in a line.

Definition at line 75 of file ss.h.

char TSsParser::SplitCh

private

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

Definition at line 79 of file ss.h.

TSsFmt TSsParser::SsFmt

private

Separator type.

Definition at line 74 of file ss.h.

---

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

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