Symbian^3 Application Developer Library >

CStifParser Class Reference

class CStifParser : public CBase

Inherits from

Public Member Functions
~CStifParser ()
IMPORT_C CStifParser * NewL (const TDesC &, const TDesC &, TCommentType )
IMPORT_C CStifParser * NewL (const TDesC &, TCommentType )
IMPORT_C CStifSectionParser * NextSectionL (const TDesC &, const TDesC &, TInt )
IMPORT_C CStifSectionParser * SectionL (const TDesC &, const TDesC &, TInt )
Private Member Functions
CStifParser ( TCommentType )
void ConstructL (const TDesC &, const TDesC &, const TDesC &)
void HandleSpecialMarks ( TPtr &)
CStifSectionParser * NextSectionFileL (const TDesC &, const TDesC &, TInt )
CStifSectionParser * NextSectionMemoryL (const TDesC &, const TDesC &, TInt )
void ParseCommentsOff ( TPtr &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum TCommentType { ENoComments , ECStyleComments }
Private Member Enumerations
enum TParsingMode { EFileParsing , EBufferParsing }
Private Attributes
TPtr iBuffer
HBufC * iBufferTmp
TCommentType iCommentType
RFile iFile
CStifFileParser * iFileParser
RFs iFileServer
TBool iIsUnicode
TInt iOffset
TParsingMode iParsingMode

Constructor & Destructor Documentation

CStifParser(TCommentType)

CStifParser ( TCommentType aCommentType ) [private]

C++ default constructor.

Parameters

TCommentType aCommentType

~CStifParser()

IMPORT_C ~CStifParser ( )

Destructor.

Member Functions Documentation

ConstructL(const TDesC &, const TDesC &, const TDesC &)

void ConstructL ( const TDesC & aPath,
const TDesC & aConfig,
const TDesC & aContent =  KNullDesC
) [private]

By default Symbian OS constructor is private.

Parameters

const TDesC & aPath
const TDesC & aConfig
const TDesC & aContent =  KNullDesC

HandleSpecialMarks(TPtr &)

void HandleSpecialMarks ( TPtr & aBuf ) [private]

Parameters

TPtr & aBuf

NewL(const TDesC &, const TDesC &, TCommentType)

IMPORT_C CStifParser * NewL ( const TDesC & aPath,
const TDesC & aConfig,
TCommentType  = ENoComments
) [static]

Two-phased constructor. Creating parser with path and file information. For default all information will be parsed(ENoComments).

Parameters

const TDesC & aPath
const TDesC & aConfig
TCommentType  = ENoComments

NewL(const TDesC &, TCommentType)

IMPORT_C CStifParser * NewL ( const TDesC & aBuffer,
TCommentType  = ENoComments
) [static]

Two-phased constructor. Creating parser with buffer information. For default all information will be parsed(ENoComments).

Parameters

const TDesC & aBuffer
TCommentType  = ENoComments

NextSectionFileL(const TDesC &, const TDesC &, TInt)

CStifSectionParser * NextSectionFileL ( const TDesC & aStartTag,
const TDesC & aEndTag,
TInt aSeeked
) [private]

Open and read configuration source and parses a required section. If start tag is empty the parsing starts beging of the configuration file. If end tag is empty the parsing goes end of configuration file. This method will parse next section after the earlier section if aSeeked parameter is not given. If configuration file includes several sections with both start and end tags so aSeeked parameter seeks the required section. The aSeeked parameters indicates section that will be parsed.

Parameters

const TDesC & aStartTag
const TDesC & aEndTag
TInt aSeeked

NextSectionL(const TDesC &, const TDesC &, TInt)

IMPORT_C CStifSectionParser * NextSectionL ( const TDesC & aStartTag,
const TDesC & aEndTag,
TInt aSeeked = 1
)

Open and read configuration source and parses a required section. If start tag is empty the parsing starts beging of the configuration file. If end tag is empty the parsing goes end of configuration file. This method will parse next section after the earlier section if aSeeked parameter is not given. If configuration file includes several sections with both start and end tags so aSeeked parameter seeks the required section. The aSeeked parameters indicates section that will be parsed.

Parameters

const TDesC & aStartTag
const TDesC & aEndTag
TInt aSeeked = 1

NextSectionMemoryL(const TDesC &, const TDesC &, TInt)

CStifSectionParser * NextSectionMemoryL ( const TDesC & aStartTag,
const TDesC & aEndTag,
TInt aSeeked
) [private]

Open and read configuration source and parses a required section. If start tag is empty the parsing starts beging of the configuration file. If end tag is empty the parsing goes end of configuration file. This method will parse next section after the earlier section if aSeeked parameter is not given. If configuration file includes several sections with both start and end tags so aSeeked parameter seeks the required section. The aSeeked parameters indicates section that will be parsed.

Parameters

const TDesC & aStartTag
const TDesC & aEndTag
TInt aSeeked

ParseCommentsOff(TPtr &)

void ParseCommentsOff ( TPtr & aBuf ) [private]

Convert a section without comments.

Parameters

TPtr & aBuf

SectionL(const TDesC &, const TDesC &, TInt)

IMPORT_C CStifSectionParser * SectionL ( const TDesC & aStartTag,
const TDesC & aEndTag,
TInt aSeeked = 1
)

Open and read configuration source and parses a required section. If start tag is empty the parsing starts beging of the configuration file. If end tag is empty the parsing goes end of configuration file. This method starts always from beginning of configuration file and parses first section if aSeeked parameters is not given. If configuration file includes several sections with both start and end tags so aSeeked parameter seeks the required section. The aSeeked parameters indicates section that will be parsed.

Parameters

const TDesC & aStartTag
const TDesC & aEndTag
TInt aSeeked = 1

Member Enumerations Documentation

Enum TCommentType

Enumerators

ENoComments
ECStyleComments

Enum TParsingMode

Enumerators

EFileParsing
EBufferParsing

Member Data Documentation

TPtr iBuffer

TPtr iBuffer [private]

HBufC * iBufferTmp

HBufC * iBufferTmp [private]

For buffer parsing.

TCommentType iCommentType

TCommentType iCommentType [private]

Comment type's indication.

RFile iFile

RFile iFile [private]

For file opening.

CStifFileParser * iFileParser

CStifFileParser * iFileParser [private]

Pointer to file parser.

RFs iFileServer

RFs iFileServer [private]

For file opening.

TBool iIsUnicode

TBool iIsUnicode [private]

Flag indicating if file is unicode.

TInt iOffset

TInt iOffset [private]

Indicates position where we are currently.

TParsingMode iParsingMode

TParsingMode iParsingMode [private]

Indication which mode of parsing are in use.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.