CVersitParser Class Reference

class CVersitParser : public CBase

A generic Versit parser.

Provides generic functions which implement behaviour common to both vCalendar and vCard parsers. For instance:

  • adding/retrieving properties and sub-entities to/from an existing entity.

  • encoding and character set conversion capabilities.

Although this is not an abstract class, in practice you would create and use objects of a derived class instead (CParserVCal or CParserVCard), as these provide additional functionality needed for parsing vCalendars and vCards.

Note: a flag used in the class constructor indicates whether the entity needs a version property. The version property will be inserted at the start of the array of properties for the entity, and specifies the version of the vCard/vCalendar specification used by the data of this particular vCard/vCalendar. The versions that are currently supported are vCard v2.1 and vCalendar v1.0.

A typical vCard looks like this:

BEGIN VCARD

VERSION 2.1 ...

END VCARD

Note: if you are sequentially creating and destroying multiple parsers, a major performance improvement may be achieved by using thread local storage to store an instance of CVersitUnicodeUtils which persists and can be used by all of the parsers.

See CVersitTlsData for more details.

Inherits from

Nested Classes and Structures

Public Member Functions
CVersitParser(TUint)
~CVersitParser()
IMPORT_C voidAddEntityL(CVersitParser *)
IMPORT_C voidAddPropertyL(CParserProperty *, TBool)
IMPORT_C voidAdjustAllPropertyDateTimesToMachineLocalL()
IMPORT_C CArrayPtr< CVersitParser > *ArrayOfEntities(TBool)
IMPORT_C CArrayPtr< CParserProperty > *ArrayOfProperties(TBool)
IMPORT_C voidConstructL()
IMPORT_C voidConvertAllPropertyDateTimesToMachineLocalL(const TTimeIntervalSeconds &, const CVersitDaylight *)
IMPORT_C TIntConvertFromUnicodeToISOL(TDes8 &, const TDesC16 &, CCnvCharacterSetConverter *)
IMPORT_C TVersitDateTime *DecodeDateTimeL(TDes &)
IMPORT_C Versit::TVersitCharSetDefaultCharSet()
IMPORT_C TUintDefaultCharSetId()
IMPORT_C Versit::TVersitEncodingDefaultEncoding()
IMPORT_C CArrayPtr< CVersitParser > *EntityL(const TDesC &, TBool)
IMPORT_C TPtrCEntityName()
IMPORT_C voidExternalizeL(RFile &)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RFile &, TInt &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C voidInternalizeL(HBufC *, CLineReader *)
IMPORT_C TBoolIsValidLabel(const TDesC &, TInt &)
IMPORT_C TBoolIsValidParameterValue(TInt &, const TDesC &)
IMPORT_C TIntLoadBinaryValuesFromFilesL()
IMPORT_C TIntLoadBinaryValuesFromFilesL(RFs &)
TUint MapVersitCharsetToCharConvCharset(Versit::TVersitCharSet)
TUint MapVersitEncodingToConArcUid(Versit::TVersitEncoding)
MVersitObserver *Observer()
MVersitPlugIn *PlugIn()
IMPORT_C CArrayPtr< CParserProperty > *PropertyL(const TDesC8 &, const TUid &, TBool)
IMPORT_C TIntRecognizeEntityName()
IMPORT_C TUidRecognizeToken(const TDesC8 &)
IMPORT_C voidResetAndDestroyArrayOfDateTimes(TAny *)
IMPORT_C voidResetAndDestroyArrayOfEntities(TAny *)
IMPORT_C voidResetAndDestroyArrayOfParams(TAny *)
IMPORT_C voidResetAndDestroyArrayOfProperties(TAny *)
IMPORT_C TIntSaveBinaryValuesToFilesL(TInt, const TDesC &)
IMPORT_C TIntSaveBinaryValuesToFilesL(TInt, const TDesC &, RFs &)
IMPORT_C voidSetAutoDetect(TBool, const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > *)
IMPORT_C voidSetCharacterConverter(Versit::TEncodingAndCharset &)
IMPORT_C voidSetDefaultCharSet(const Versit::TVersitCharSet)
IMPORT_C voidSetDefaultCharSetId(TUint)
IMPORT_C voidSetDefaultEncoding(const Versit::TVersitEncoding)
IMPORT_C voidSetEntityNameL(const TDesC &)
voidSetFlags(TUint)
voidSetObserver(MVersitObserver *)
voidSetPlugIn(MVersitPlugIn *)
IMPORT_C TIntVal(const TDesC &, TInt &)
Protected Member Functions
IMPORT_C voidAnalysesEncodingCharset(CArrayPtr< CParserParam > *)
IMPORT_C voidAppendBeginL()
IMPORT_C voidAppendEndL()
voidAppendEntityNameL()
TPtr8 &BufPtr()
voidClearSupportsVersion()
IMPORT_C TIntConvertToUnicodeFromISOL(TDes16 &, const TDesC8 &, TUint)
HBufC *ConvertToUnicodeL(const TDesC8 &)
IMPORT_C HBufC *DecodePropertyValueL(const TDesC8 &)
IMPORT_C voidDecodePropertyValueL(const TDesC8 &, const TUid &)
IMPORT_C TTime *DecodeTimePeriodL(const TDesC &)
IMPORT_C TTimeIntervalSecondsDecodeTimeZoneL(const TDesC &)
IMPORT_C voidDoAddPropertyL(CParserProperty *)
IMPORT_C TBoolFindFirstField(TPtr16 &, TPtr16 &, TBool)
IMPORT_C voidFindRemainingField(TPtr16 &, TPtr16 &)
IMPORT_C TIntGetNumberL(const TDesC &, TInt &)
IMPORT_C CArrayPtr< CParserParam > *GetPropertyParamsLC(TPtr8)
TBool IsPunctuationToken(TUint)
IMPORT_C Versit::TVersitCharSetLineCharSet()
IMPORT_C TUintLineCharSetId()
IMPORT_C Versit::TVersitEncodingLineEncoding()
IMPORT_C TUintLineEncodingId()
CParserPropertyValueHBufC *MakeDefaultPropertyValueL(HBufC16 *&)
IMPORT_C CVersitParser *MakeEntityL(TInt, HBufC *)
IMPORT_C voidMakePropertyL(TPtr8 &, TInt)
IMPORT_C CDesCArray *MakePropertyValueCDesCArrayL(TPtr16)
IMPORT_C CVersitDaylight *MakePropertyValueDaylightL(TPtr16)
IMPORT_C CParserPropertyValue *MakePropertyValueL(const TUid &, HBufC16 *&)
IMPORT_C CArrayPtr< TVersitDateTime > *MakePropertyValueMultiDateTimeL(TPtr16)
IMPORT_C voidParseBeginL()
IMPORT_C voidParseEndL()
voidParseEndL(HBufC16 &)
IMPORT_C TBoolParseEntityL()
IMPORT_C voidParseParamL(CArrayPtr< CParserParam > *, TPtr8)
IMPORT_C voidParsePropertiesL()
IMPORT_C voidParsePropertyL()
IMPORT_C CArrayPtr< CParserParam > *ReadLineAndDecodeParamsLC(TInt &, TInt &)
IMPORT_C voidReadMultiLineValueL(TPtr8 &, TInt, TBool)
IMPORT_C voidRestoreLineCodingDetailsToDefault()
IMPORT_C voidSetLineCharacterSet(Versit::TVersitCharSet)
IMPORT_C voidSetLineCharacterSetId(TUint)
IMPORT_C voidSetLineCoding(Versit::TVersitCharSet, Versit::TVersitEncoding)
IMPORT_C voidSetLineEncoding(Versit::TVersitEncoding)
IMPORT_C voidSetLineEncoding(TUint)
voidSetSupportsVersion()
TBool SupportsVersion()
CVersitUnicodeUtils &UnicodeUtils()
Private Member Functions
voidConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &, const CVersitDaylight *)
voidConvertUTCDateTimeToMachineLocal(TVersitDateTime *, const TTimeIntervalSeconds &, const CVersitDaylight *)
voidDoInternalizeL()
IMPORT_C voidReserved1()
IMPORT_C voidReserved2()
voidSetLineCharsetDetailsToDefault()
voidSetLineEncodingDetailsToDefault()
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
enumTCharCodes { ESpace = ' ', EHTab = 9, ELineFeed = 10, ECarriageReturn = 13, EColon = ':' }
enumTVersitParserFlags {
ENoVersionProperty = 0, ESupportsVersion = 0x01, EImportSyncML = 0x1000, EUseAutoDetection = 0x4000, ECharSetIdentified = 0x8000, EUseDefaultCharSetForAllProperties = 0x2000
}
Protected Attributes
CArrayPtr< CVersitParser > *iArrayOfEntities
CArrayPtr< CParserProperty > *iArrayOfProperties
const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > *iAutoDetectCharSets
CParserProperty *iCurrentProperty
TParserCodingDetails iCurrentPropertyCodingDetails
HBufC8 *iDecodedValue
TParserCodingDetails iDefaultCodingDetails
TBuf< KVersitMaxVersionLength >iDefaultVersion
HBufC *iEntityName
TInt iFlags
CBufSeg *iLargeDataBuf
CLineReader *iLineReader
MVersitObserver *iObserver
CLineReader *iOwnedLineReader
MVersitPlugIn *iPlugIn
CVersitTlsData *iStaticUtils
RWriteStream *iWriteStream
Private Attributes
TInt iParseBegin
TInt iReserved2

Constructor & Destructor Documentation

CVersitParser(TUint)

IMPORT_CCVersitParser(TUintaFlags)

Parameters

TUint aFlags

~CVersitParser()

IMPORT_C~CVersitParser()

Member Functions Documentation

AddEntityL(CVersitParser *)

IMPORT_C voidAddEntityL(CVersitParser *aEntity)

Parameters

CVersitParser * aEntity

AddPropertyL(CParserProperty *, TBool)

IMPORT_C voidAddPropertyL(CParserProperty *aProperty,
TBoolaInternalizing = EFalse
)

Parameters

CParserProperty * aProperty
TBool aInternalizing = EFalse

AdjustAllPropertyDateTimesToMachineLocalL()

IMPORT_C voidAdjustAllPropertyDateTimesToMachineLocalL()

AnalysesEncodingCharset(CArrayPtr< CParserParam > *)

IMPORT_C voidAnalysesEncodingCharset(CArrayPtr< CParserParam > *aArrayOfParams)[protected]

Parameters

CArrayPtr< CParserParam > * aArrayOfParams

AppendBeginL()

IMPORT_C voidAppendBeginL()[protected]

AppendEndL()

IMPORT_C voidAppendEndL()[protected]

AppendEntityNameL()

voidAppendEntityNameL()[protected]

ArrayOfEntities(TBool)

IMPORT_C CArrayPtr< CVersitParser > *ArrayOfEntities(TBoolaTakeOwnership = ETrue)

Parameters

TBool aTakeOwnership = ETrue

ArrayOfProperties(TBool)

IMPORT_C CArrayPtr< CParserProperty > *ArrayOfProperties(TBoolaTakeOwnership = ETrue)

Parameters

TBool aTakeOwnership = ETrue

BufPtr()

TPtr8 &BufPtr()[protected, inline]

ClearSupportsVersion()

voidClearSupportsVersion()[protected, inline]

ConstructL()

IMPORT_C voidConstructL()

ConvertAllPropertyDateTimesToMachineLocalL(const TTimeIntervalSeconds &, const CVersitDaylight *)

IMPORT_C voidConvertAllPropertyDateTimesToMachineLocalL(const TTimeIntervalSeconds &aIncrement,
const CVersitDaylight *aDaylight
)[virtual]

Parameters

const TTimeIntervalSeconds & aIncrement
const CVersitDaylight * aDaylight

ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &, const CVersitDaylight *)

voidConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &aIncrement,
const CVersitDaylight *aDaylight
)[private]

Parameters

const TTimeIntervalSeconds & aIncrement
const CVersitDaylight * aDaylight

ConvertFromUnicodeToISOL(TDes8 &, const TDesC16 &, CCnvCharacterSetConverter *)

IMPORT_C TIntConvertFromUnicodeToISOL(TDes8 &aIso,
const TDesC16 &aUnicode,
CCnvCharacterSetConverter *aConverter
)[static]

Parameters

TDes8 & aIso
const TDesC16 & aUnicode
CCnvCharacterSetConverter * aConverter

ConvertToUnicodeFromISOL(TDes16 &, const TDesC8 &, TUint)

IMPORT_C TIntConvertToUnicodeFromISOL(TDes16 &aUnicode,
const TDesC8 &aIso,
TUintaCharacterSet
)[protected]

Parameters

TDes16 & aUnicode
const TDesC8 & aIso
TUint aCharacterSet

ConvertToUnicodeL(const TDesC8 &)

HBufC *ConvertToUnicodeL(const TDesC8 &aValue)[protected]

Parameters

const TDesC8 & aValue

ConvertUTCDateTimeToMachineLocal(TVersitDateTime *, const TTimeIntervalSeconds &, const CVersitDaylight *)

voidConvertUTCDateTimeToMachineLocal(TVersitDateTime *aDateTime,
const TTimeIntervalSeconds &aIncrement,
const CVersitDaylight *aDaylight
)[private]

Parameters

TVersitDateTime * aDateTime
const TTimeIntervalSeconds & aIncrement
const CVersitDaylight * aDaylight

DecodeDateTimeL(TDes &)

IMPORT_C TVersitDateTime *DecodeDateTimeL(TDes &aToken)const

Parameters

TDes & aToken

DecodePropertyValueL(const TDesC8 &)

IMPORT_C HBufC *DecodePropertyValueL(const TDesC8 &aValue)[protected]

Parameters

const TDesC8 & aValue

DecodePropertyValueL(const TDesC8 &, const TUid &)

IMPORT_C voidDecodePropertyValueL(const TDesC8 &aValue,
const TUid &aEncodingUid
)[protected]

Parameters

const TDesC8 & aValue
const TUid & aEncodingUid

DecodeTimePeriodL(const TDesC &)

IMPORT_C TTime *DecodeTimePeriodL(const TDesC &aToken)const [protected]

Parameters

const TDesC & aToken

DecodeTimeZoneL(const TDesC &)

IMPORT_C TTimeIntervalSecondsDecodeTimeZoneL(const TDesC &aToken)const [protected]

Parameters

const TDesC & aToken

DefaultCharSet()

IMPORT_C Versit::TVersitCharSetDefaultCharSet()const

DefaultCharSetId()

IMPORT_C TUintDefaultCharSetId()const

DefaultEncoding()

IMPORT_C Versit::TVersitEncodingDefaultEncoding()const

DoAddPropertyL(CParserProperty *)

IMPORT_C voidDoAddPropertyL(CParserProperty *aProperty)[protected]

Parameters

CParserProperty * aProperty

DoInternalizeL()

voidDoInternalizeL()[private]

EntityL(const TDesC &, TBool)

IMPORT_C CArrayPtr< CVersitParser > *EntityL(const TDesC &aEntityName,
TBoolaTakeOwnership = ETrue
)

Parameters

const TDesC & aEntityName
TBool aTakeOwnership = ETrue

EntityName()

IMPORT_C TPtrCEntityName()const

ExternalizeL(RFile &)

IMPORT_C voidExternalizeL(RFile &aOutputFile)

Parameters

RFile & aOutputFile

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)[virtual]

Parameters

RWriteStream & aStream

FindFirstField(TPtr16 &, TPtr16 &, TBool)

IMPORT_C TBoolFindFirstField(TPtr16 &aField,
TPtr16 &aRemaining,
TBoolaTrimSpace = ETrue
)[protected]

Parameters

TPtr16 & aField
TPtr16 & aRemaining
TBool aTrimSpace = ETrue

FindRemainingField(TPtr16 &, TPtr16 &)

IMPORT_C voidFindRemainingField(TPtr16 &aField,
TPtr16 &aRemaining
)[protected]

Parameters

TPtr16 & aField
TPtr16 & aRemaining

GetNumberL(const TDesC &, TInt &)

IMPORT_C TIntGetNumberL(const TDesC &aToken,
TInt &aNumChars
)const [protected]

Parameters

const TDesC & aToken
TInt & aNumChars

GetPropertyParamsLC(TPtr8)

IMPORT_C CArrayPtr< CParserParam > *GetPropertyParamsLC(TPtr8aParams)[protected]

Parameters

TPtr8 aParams

InternalizeL(RFile &, TInt &)

IMPORT_C voidInternalizeL(RFile &aInputFile,
TInt &aBytesThroughFile
)

Parameters

RFile & aInputFile
TInt & aBytesThroughFile

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)[virtual]

Parameters

RReadStream & aStream

InternalizeL(HBufC *, CLineReader *)

IMPORT_C voidInternalizeL(HBufC *aEntityName,
CLineReader *aLineReader
)[virtual]

Parameters

HBufC * aEntityName
CLineReader * aLineReader

IsPunctuationToken(TUint)

TBool IsPunctuationToken(TUintaChar)[protected, static]

Parameters

TUint aChar

IsValidLabel(const TDesC &, TInt &)

IMPORT_C TBoolIsValidLabel(const TDesC &aLabel,
TInt &aPos
)[static]

Parameters

const TDesC & aLabel
TInt & aPos

IsValidParameterValue(TInt &, const TDesC &)

IMPORT_C TBoolIsValidParameterValue(TInt &aPos,
const TDesC &aParamValue
)[static]

Parameters

TInt & aPos
const TDesC & aParamValue

LineCharSet()

IMPORT_C Versit::TVersitCharSetLineCharSet()const [protected]

LineCharSetId()

IMPORT_C TUintLineCharSetId()const [protected]

LineEncoding()

IMPORT_C Versit::TVersitEncodingLineEncoding()const [protected]

LineEncodingId()

IMPORT_C TUintLineEncodingId()const [protected]

LoadBinaryValuesFromFilesL()

IMPORT_C TIntLoadBinaryValuesFromFilesL()

LoadBinaryValuesFromFilesL(RFs &)

IMPORT_C TIntLoadBinaryValuesFromFilesL(RFs &aFileSession)

Parameters

RFs & aFileSession

MakeDefaultPropertyValueL(HBufC16 *&)

CParserPropertyValueHBufC *MakeDefaultPropertyValueL(HBufC16 *&aValue)[protected]

Parameters

HBufC16 *& aValue

MakeEntityL(TInt, HBufC *)

IMPORT_C CVersitParser *MakeEntityL(TIntaEntityUid,
HBufC *aEntityName
)[protected, virtual]

Parameters

TInt aEntityUid
HBufC * aEntityName

MakePropertyL(TPtr8 &, TInt)

IMPORT_C voidMakePropertyL(TPtr8 &aPropName,
TIntaValueStart
)[protected]

Parameters

TPtr8 & aPropName
TInt aValueStart

MakePropertyValueCDesCArrayL(TPtr16)

IMPORT_C CDesCArray *MakePropertyValueCDesCArrayL(TPtr16aStringValue)[protected]

Parameters

TPtr16 aStringValue

MakePropertyValueDaylightL(TPtr16)

IMPORT_C CVersitDaylight *MakePropertyValueDaylightL(TPtr16aDaylightValue)[protected]

Parameters

TPtr16 aDaylightValue

MakePropertyValueL(const TUid &, HBufC16 *&)

IMPORT_C CParserPropertyValue *MakePropertyValueL(const TUid &aPropertyUid,
HBufC16 *&aValue
)[protected, virtual]

Parameters

const TUid & aPropertyUid
HBufC16 *& aValue

MakePropertyValueMultiDateTimeL(TPtr16)

IMPORT_C CArrayPtr< TVersitDateTime > *MakePropertyValueMultiDateTimeL(TPtr16aDateTimeGroup)[protected]

Parameters

TPtr16 aDateTimeGroup

MapVersitCharsetToCharConvCharset(Versit::TVersitCharSet)

TUint MapVersitCharsetToCharConvCharset(Versit::TVersitCharSetaVersitSet)[static]

Parameters

Versit::TVersitCharSet aVersitSet

MapVersitEncodingToConArcUid(Versit::TVersitEncoding)

TUint MapVersitEncodingToConArcUid(Versit::TVersitEncodingaVersitEncoding)[static]

Parameters

Versit::TVersitEncoding aVersitEncoding

Observer()

MVersitObserver *Observer()[inline]

Gets a pointer to the Versit observer.

A pointer to the observer.

ParseBeginL()

IMPORT_C voidParseBeginL()[protected]

ParseEndL()

IMPORT_C voidParseEndL()[protected]

ParseEndL(HBufC16 &)

voidParseEndL(HBufC16 &aEntityName)[protected]

Parameters

HBufC16 & aEntityName

ParseEntityL()

IMPORT_C TBoolParseEntityL()[protected]

ParseParamL(CArrayPtr< CParserParam > *, TPtr8)

IMPORT_C voidParseParamL(CArrayPtr< CParserParam > *aArray,
TPtr8aParam
)[protected]

Parameters

CArrayPtr< CParserParam > * aArray
TPtr8 aParam

ParsePropertiesL()

IMPORT_C voidParsePropertiesL()[protected]

ParsePropertyL()

IMPORT_C voidParsePropertyL()[protected, virtual]

PlugIn()

MVersitPlugIn *PlugIn()[inline]

Gets a pointer to the Versit plug-in.

A pointer to the plug-in.

PropertyL(const TDesC8 &, const TUid &, TBool)

IMPORT_C CArrayPtr< CParserProperty > *PropertyL(const TDesC8 &aPropertyName,
const TUid &aPropertyUid,
TBoolaTakeOwnership = ETrue
)const

Parameters

const TDesC8 & aPropertyName
const TUid & aPropertyUid
TBool aTakeOwnership = ETrue

ReadLineAndDecodeParamsLC(TInt &, TInt &)

IMPORT_C CArrayPtr< CParserParam > *ReadLineAndDecodeParamsLC(TInt &aValueStart,
TInt &aNameLen
)[protected]

Parameters

TInt & aValueStart
TInt & aNameLen

ReadMultiLineValueL(TPtr8 &, TInt, TBool)

IMPORT_C voidReadMultiLineValueL(TPtr8 &aValue,
TIntaValueStart,
TBoolaBinaryData
)[protected]

Parameters

TPtr8 & aValue
TInt aValueStart
TBool aBinaryData

RecognizeEntityName()

IMPORT_C TIntRecognizeEntityName()const [virtual]

RecognizeToken(const TDesC8 &)

IMPORT_C TUidRecognizeToken(const TDesC8 &aToken)const [virtual]

Parameters

const TDesC8 & aToken

Reserved1()

IMPORT_C voidReserved1()[private, virtual]

Reserved2()

IMPORT_C voidReserved2()[private, virtual]

ResetAndDestroyArrayOfDateTimes(TAny *)

IMPORT_C voidResetAndDestroyArrayOfDateTimes(TAny *aObject)[static]

Parameters

TAny * aObject

ResetAndDestroyArrayOfEntities(TAny *)

IMPORT_C voidResetAndDestroyArrayOfEntities(TAny *aObject)[static]

Parameters

TAny * aObject

ResetAndDestroyArrayOfParams(TAny *)

IMPORT_C voidResetAndDestroyArrayOfParams(TAny *aObject)[static]

Parameters

TAny * aObject

ResetAndDestroyArrayOfProperties(TAny *)

IMPORT_C voidResetAndDestroyArrayOfProperties(TAny *aObject)[static]

Parameters

TAny * aObject

RestoreLineCodingDetailsToDefault()

IMPORT_C voidRestoreLineCodingDetailsToDefault()[protected]

SaveBinaryValuesToFilesL(TInt, const TDesC &)

IMPORT_C TIntSaveBinaryValuesToFilesL(TIntaSizeThreshold,
const TDesC &aPath
)

Parameters

TInt aSizeThreshold
const TDesC & aPath

SaveBinaryValuesToFilesL(TInt, const TDesC &, RFs &)

IMPORT_C TIntSaveBinaryValuesToFilesL(TIntaSizeThreshold,
const TDesC &aPath,
RFs &aFileSession
)

Parameters

TInt aSizeThreshold
const TDesC & aPath
RFs & aFileSession

SetAutoDetect(TBool, const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > *)

IMPORT_C voidSetAutoDetect(TBoolaOn,
const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > *aAutoDetectCharSets = NULL
)

Parameters

TBool aOn
const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > * aAutoDetectCharSets = NULL

SetCharacterConverter(Versit::TEncodingAndCharset &)

IMPORT_C voidSetCharacterConverter(Versit::TEncodingAndCharset &encodingAndCharset)

Parameters

Versit::TEncodingAndCharset & encodingAndCharset

SetDefaultCharSet(const Versit::TVersitCharSet)

IMPORT_C voidSetDefaultCharSet(const Versit::TVersitCharSetaCharSet)

Parameters

const Versit::TVersitCharSet aCharSet

SetDefaultCharSetId(TUint)

IMPORT_C voidSetDefaultCharSetId(TUintaCharSetId)

Parameters

TUint aCharSetId

SetDefaultEncoding(const Versit::TVersitEncoding)

IMPORT_C voidSetDefaultEncoding(const Versit::TVersitEncodingaEncoding)

Parameters

const Versit::TVersitEncoding aEncoding

SetEntityNameL(const TDesC &)

IMPORT_C voidSetEntityNameL(const TDesC &aEntityName)

Parameters

const TDesC & aEntityName

SetFlags(TUint)

voidSetFlags(TUintaFlags)[inline]

Parameters

TUint aFlags

SetLineCharacterSet(Versit::TVersitCharSet)

IMPORT_C voidSetLineCharacterSet(Versit::TVersitCharSetaLineCharSet)[protected]

Parameters

Versit::TVersitCharSet aLineCharSet

SetLineCharacterSetId(TUint)

IMPORT_C voidSetLineCharacterSetId(TUintaLineCharSetId)[protected]

Parameters

TUint aLineCharSetId

SetLineCharsetDetailsToDefault()

voidSetLineCharsetDetailsToDefault()[private]

SetLineCoding(Versit::TVersitCharSet, Versit::TVersitEncoding)

IMPORT_C voidSetLineCoding(Versit::TVersitCharSetaLineCharSet,
Versit::TVersitEncodingaLineEncoding
)[protected]

Parameters

Versit::TVersitCharSet aLineCharSet
Versit::TVersitEncoding aLineEncoding

SetLineEncoding(Versit::TVersitEncoding)

IMPORT_C voidSetLineEncoding(Versit::TVersitEncodingaLineEncoding)[protected]

Parameters

Versit::TVersitEncoding aLineEncoding

SetLineEncoding(TUint)

IMPORT_C voidSetLineEncoding(TUintaVersitEncodingUid)[protected]

Parameters

TUint aVersitEncodingUid

SetLineEncodingDetailsToDefault()

voidSetLineEncodingDetailsToDefault()[private]

SetObserver(MVersitObserver *)

voidSetObserver(MVersitObserver *aObserver)[inline]

Sets the Versit observer.

Parameters

MVersitObserver * aObserverA pointer to the observer.

SetPlugIn(MVersitPlugIn *)

voidSetPlugIn(MVersitPlugIn *aPlugIn)[inline]

Sets the Versit plug-in.

If there is one, the Versit plug-in needs to be set before any properties are added to the parser. This is done for you when internalising (using InternalizeL()) or adding properties (using AddPropertyL()).

Parameters

MVersitPlugIn * aPlugInA pointer to the plug in.

SetSupportsVersion()

voidSetSupportsVersion()[protected, inline]

SupportsVersion()

TBool SupportsVersion()const [protected, inline]

UnicodeUtils()

CVersitUnicodeUtils &UnicodeUtils()[protected, inline]

Val(const TDesC &, TInt &)

IMPORT_C TIntVal(const TDesC &aString,
TInt &aNumber
)[static]

Parameters

const TDesC & aString
TInt & aNumber

Member Enumerations Documentation

Enum TCharCodes

White space character codes: used while analysing the syntax of the received data and while externalising data.

Enumerators

ESpace = ' '

' '

EHTab = 9

9

ELineFeed = 10

10

ECarriageReturn = 13

13

EColon = ':'

':'

Enum TVersitParserFlags

Flags that can be specified on construction.

Enumerators

ENoVersionProperty = 0

This entity does not need a version property.

ESupportsVersion = 0x01

This entity should have a version property.

EImportSyncML = 0x1000
EUseAutoDetection = 0x4000

Indicates whether the parser should use auto-detection of character sets when one has not been explicitly specified.

ECharSetIdentified = 0x8000

The current property has specified a character set.

EUseDefaultCharSetForAllProperties = 0x2000

If the charset is not explicitly specified, the default charset will be used instead of US-ASCII as required by the Versit specification .

Member Data Documentation

CArrayPtr< CVersitParser > * iArrayOfEntities

CArrayPtr< CVersitParser > *iArrayOfEntities[protected]

CArrayPtr< CParserProperty > * iArrayOfProperties

CArrayPtr< CParserProperty > *iArrayOfProperties[protected]

const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > * iAutoDetectCharSets

const CArrayFix< CCnvCharacterSetConverter::SCharacterSet > *iAutoDetectCharSets[protected]

CParserProperty * iCurrentProperty

CParserProperty *iCurrentProperty[protected]

TParserCodingDetails iCurrentPropertyCodingDetails

TParserCodingDetails iCurrentPropertyCodingDetails[protected]

HBufC8 * iDecodedValue

HBufC8 *iDecodedValue[protected]

TParserCodingDetails iDefaultCodingDetails

TParserCodingDetails iDefaultCodingDetails[protected]

TBuf< KVersitMaxVersionLength > iDefaultVersion

TBuf< KVersitMaxVersionLength >iDefaultVersion[protected]

HBufC * iEntityName

HBufC *iEntityName[protected]

TInt iFlags

TInt iFlags[protected]

CBufSeg * iLargeDataBuf

CBufSeg *iLargeDataBuf[protected]

CLineReader * iLineReader

CLineReader *iLineReader[protected]

MVersitObserver * iObserver

MVersitObserver *iObserver[protected]

CLineReader * iOwnedLineReader

CLineReader *iOwnedLineReader[protected]

TInt iParseBegin

TInt iParseBegin[private]

MVersitPlugIn * iPlugIn

MVersitPlugIn *iPlugIn[protected]

TInt iReserved2

TInt iReserved2[private]

CVersitTlsData * iStaticUtils

CVersitTlsData *iStaticUtils[protected]

RWriteStream * iWriteStream

RWriteStream *iWriteStream[protected]
© Nokia 2010.