Class CShgFormulaViewer

class CShgFormulaViewer : public CBase;

Description

Handles conversion of formula tokens (TFormulaToken) into localised strings suitable for display to users.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CShgFormulaViewer - Handles conversion of formula tokens (TFormulaToken) into localised strings suit...

Members

Defined in CShgFormulaViewer:

• EFnDatabaseDatabase.
• EFnDateAndTimeDate/time.
• EFnErrorError.
• EFnFinancialFinancial.
• EFnInformationInformation.
• EFnLogicalLogical.
• EFnLookUpLook-up.
• EFnMathematicalMathematical.
• EFnStatisticalStatistical.
• EFnTextText.
• EFormulaEqualsSignCharacter for the formula equals sign.
• FirstFunctionNo()constGets the first token (as ordered in TFormulaToken) that represents a function.
• FormulaEvaluator()constGets a formula evaluator object.
• FunctionName(TFormulaToken)constGets a localised string for a specified formula token.
• FunctionType(TFormulaToken)constGets the type (financial, statistical, etc.) of a specified function.
• GetTextFormulaL()Gets a text representation of a formula.
• GetTokenFormulaL(TShgError &)Gets a token representation of a formula.
• InitWithTextFormula(const TCellRef &,const TDesC &)Initialises the viewer with text data.
• InitWithTokenFormula(const TCellRef &,const TDesC8 *)Initialises the viewer with formula data.
• LastFunctionNo()constGets the last token (as ordered in TFormulaToken) that represents a function.
• NewL(const CShgNameSet *,const CShgWorkBook *,CSheetEngine *,const TDesC &)Allocates and constructs a new formula viewer.
• NoArguments(TFormulaToken)constGets the number of arguments required for a specified function.
• TFunctionTypeTypes of function.
• anonymousCharacter definition.
• sFunction
• sSkipToken
• ~CShgFormulaViewer()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

virtual ~CShgFormulaViewer();

Description

Destructor.

IMPORT_C static CShgFormulaViewer* NewL(const CShgNameSet *aNameSet, const CShgWorkBook *aWorkBook, CSheetEngine *aSheetEngine, const TDesC &aResourceFile);

Description

Allocates and constructs a new formula viewer.

Parameters

Return value

IMPORT_C void InitWithTokenFormula(const TCellRef &aCell, const TDesC8 *aFormula);

Description

Initialises the viewer with formula data.

!! this is very inefficient

!! unfortunately size of this is being used as a flag!!!

Parameters

IMPORT_C void InitWithTextFormula(const TCellRef &aCell, const TDesC &aText);

Description

Initialises the viewer with text data.

Parameters

IMPORT_C const TPtrC GetTextFormulaL();

Description

Gets a text representation of a formula.

The function converts formula data to text if necessary.

Return value

IMPORT_C const TPtrC8 GetTokenFormulaL(TShgError &aError);

Description

Gets a token representation of a formula.

The function converts formula data to tokens if necessary.

Parameters

Return value

inline CShgFormulaEvaluator* FormulaEvaluator() const;

Description

Gets a formula evaluator object.

Return value

IMPORT_C TInt FirstFunctionNo() const;

Description

Gets the first token (as ordered in TFormulaToken) that represents a function.

Return value

IMPORT_C TInt LastFunctionNo() const;

Description

Gets the last token (as ordered in TFormulaToken) that represents a function.

Return value

IMPORT_C const TPtrC FunctionName(TFormulaToken aToken) const;

Description

Gets a localised string for a specified formula token.

Parameters

Return value

IMPORT_C TFunctionType FunctionType(TFormulaToken aToken) const;

Description

Gets the type (financial, statistical, etc.) of a specified function.

Parameters

Return value

IMPORT_C TInt NoArguments(TFormulaToken aToken) const;

Description

Gets the number of arguments required for a specified function.

Parameters

Return value

n/a

Description

Character definition.

TFunctionType

Description

Types of function.

const TUint8 sSkipToken[256]={
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,0x80|2,2,2,2,2,2,2,2,2,2,10,
        6,4,4,0,0,0x80|6,0x80|2,0x80|8,0x80|14,0x80|14,2,6,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
        2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,3,
        };

Description

const CShgFormulaEvaluator::TFunction sFunction[ETokLastArrayFn+1]={

    {&ShgFormula::FnNoAction,   0,   0,   0,   0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpCompareL, 0, 0, 0, 0},
    {&ShgFormula::FnOpAddL,     0, 0, 0, 0},
    {&ShgFormula::FnOpSubtractL,0,  0,    0,  0},
    {&ShgFormula::FnOpMultiplyL,0,  0,    0,  0},
    {&ShgFormula::FnOpDivideL,  0,    0,  0,    0},
    {&ShgFormula::FnOpPowerL,   0,   0,   0,   0},
    {&ShgFormula::FnNoAction,   0,   0,   0,   0},
    {&ShgFormula::FnOpUnaryMinusL,  0,    0,  0,    0},
    {&ShgFormula::FnOpLogicalNotL,  0,    0,  0,    0},
    {&ShgFormula::FnOpLogicalAndL,  0,    0,  0,    0},
    {&ShgFormula::FnOpLogicalOrL,   0,   0,   0,   0},
    {&ShgFormula::FnOpConcatenateL, 0, 0, 0, 0},

    {&ShgFormula::FnNoAction,   0,   0,   0,   0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},

    {&ShgFormula::FnNoAction,   0,   0,   0,   0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},
    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},

    {&ShgFormula::FnDmBadCodeL, 0, 0, 0, 0},

    {&ShgFormula::FnCnRealL,    0,  0,    0,  0},
    {&ShgFormula::FnCnIntL,     0, 0, 0, 0},
    {&ShgFormula::FnCnInt8L,    0,  0,    0,  0},
    {&ShgFormula::FnCnInt16L,   0,   0,   0,   0},
    {&ShgFormula::FnCnNullL,    0,  0,    0,  0},
    {&ShgFormula::FnCnArrayL,   0,   0,   0,   0},
    {&ShgFormula::FnCnNameL,    0,  0,    0,  0},
    {&ShgFormula::FnCnTextL,    0,  0,    0,  0},
    {&ShgFormula::FnCnCellL,    0,  0,    0,  0},
    {&ShgFormula::FnCnRangeL,   0,   0,   0,   0},

    {&ShgFormula::FnStatRangeL, 0, 0, 0, 0},
    {&ShgFormula::FnStatLitL,   0,   0,   0,   0},
    {&ShgFormula::FnStatEndL,   0,   0xff,    0x02,   0},


    {&ShgFormula::FnErrNullL,   EFnError,        0,  0x00, 0},    
    {&ShgFormula::FnErrDivByZeroL,EFnError,     0, 0x00,  0},   
    {&ShgFormula::FnErrValueL,  EFnError,     0, 0x00,  0},   
    {&ShgFormula::FnErrRefL,    EFnError,       0,   0x00,    0}, 
    {&ShgFormula::FnErrNameL,   EFnError,        0,  0x00, 0},    
    {&ShgFormula::FnErrNumL,    EFnError,       0,   0x00,    0}, 
    {&ShgFormula::FnErrNaL,     EFnError,      0,    0x00,   0},  


    {&ShgFormula::FnFalseL,     EFnLogical,        0,  0x00, 0},    
    {&ShgFormula::FnIfL,        EFnLogical,     3, 0x00,  0},   
    {&ShgFormula::FnTrueL,      EFnLogical,       0,   0x00,    0}, 


    {&ShgFormula::FnCellL,      EFnInformation,   2,   0x04,    0}, 
    {&ShgFormula::FnErrorTypeL, EFnInformation,    1,  0x00, 0},    
    {&ShgFormula::FnIsBlankL,   EFnInformation,  1,    0x00,   0},  
    {&ShgFormula::FnIsErrL,     EFnInformation,    1,  0x00, 0},    
    {&ShgFormula::FnIsErrorL,   EFnInformation,  1,    0x00,   0},  
    {&ShgFormula::FnIsLogicalL, EFnInformation,    1,  0x00, 0},    
    {&ShgFormula::FnIsNaL,      EFnInformation,   1,   0x00,    0}, 
    {&ShgFormula::FnIsNonTextL, EFnInformation,    1,  0x00, 0},    
    {&ShgFormula::FnIsNumberL,  EFnInformation,   1,   0x00,    0}, 
    {&ShgFormula::FnIsTextL,    EFnInformation, 1, 0x00,  0},   
    {&ShgFormula::FnNL,         EFnInformation,    1,  0x01, 0},    
    {&ShgFormula::FnTypeL,      EFnInformation,   1,   0x00,    0}, 


    {&ShgFormula::FnAddressL,   EFnLookUp,       2,   0x00,    0}, 
    {&ShgFormula::FnColumnL,    EFnLookUp,      1,    0x01,   0},  
    {&ShgFormula::FnColumnsL,   EFnLookUp,       1,   0x01,    0}, 
    {&ShgFormula::FnHLookUpL,   EFnLookUp,       3,   0x04,    0}, 
    {&ShgFormula::FnIndexL,     EFnLookUp,     3, 0x01,  0},   
    {&ShgFormula::FnIndirectL,  EFnLookUp,        1,  0x00, 0},    
    {&ShgFormula::FnLookUpL,    EFnLookUp,      3,    0x14,   0},  
    {&ShgFormula::FnOffsetL,    EFnLookUp,      3,    0x01,   0},  
    {&ShgFormula::FnRowL,       EFnLookUp,       1,   0x01,    0}, 
    {&ShgFormula::FnRowsL,      EFnLookUp,        1,  0x01, 0},    
    {&ShgFormula::FnVLookUpL,   EFnLookUp,       3,   0x04,    0}, 



    {&ShgFormula::FnCharL,      EFnText,      1,    0x00,   0},  
    {&ShgFormula::FnCodeL,      EFnText,      1,    0x00,   0},  
    {&ShgFormula::FnExactL,     EFnText,       2,   0x00,    0}, 
    {&ShgFormula::FnFindL,      EFnText,      3,    0x00,   0},  
    {&ShgFormula::FnLeftL,      EFnText,      2,    0x00,   0},  
    {&ShgFormula::FnLengthL,    EFnText,        1,  0x00, 0},    
    {&ShgFormula::FnLowerL,     EFnText,       1,   0x00,    0}, 
    {&ShgFormula::FnMidL,       EFnText,     3, 0x00,  0},   
    {&ShgFormula::FnProperL,    EFnText,        1,  0x00, 0},    
    {&ShgFormula::FnReplaceL,   EFnText,     4, 0x00,  0},   
    {&ShgFormula::FnRepeatL,    EFnText,        2,  0x00, 0},    
    {&ShgFormula::FnRightL,     EFnText,       2,   0x00,    0}, 
    {&ShgFormula::FnStringL,    EFnText,        2,  0x00, 0},    
    {&ShgFormula::FnTL,         EFnInformation,    1,  0x01, 0},    
    {&ShgFormula::FnTrimL,      EFnText,      1,    0x00,   0},  
    {&ShgFormula::FnUpperL,     EFnText,       1,   0x00,    0}, 
    {&ShgFormula::FnValueL,     EFnText,       1,   0x00,    0}, 


    {&ShgFormula::FnDateL,      EFnDateAndTime,   3,   0x00,    0}, 
    {&ShgFormula::FnDateValueL, EFnDateAndTime,    1,  0x00, 0},    
    {&ShgFormula::FnDayL,       EFnDateAndTime,  1,    0x00,   0},  
    {&ShgFormula::FnHourL,      EFnDateAndTime,   1,   0x00,    0}, 
    {&ShgFormula::FnMinuteL,    EFnDateAndTime, 1, 0x00,  0},   
    {&ShgFormula::FnMonthL,     EFnDateAndTime,    1,  0x00, 0},    
    {&ShgFormula::FnNowL,       EFnDateAndTime,  0,    0x00,   0},  
    {&ShgFormula::FnSecondL,    EFnDateAndTime, 1, 0x00,  0},   
    {&ShgFormula::FnTodayL,     EFnDateAndTime,    0,  0x00, 0},    
    {&ShgFormula::FnTimeL,      EFnDateAndTime,   3,   0x00,    0}, 
    {&ShgFormula::FnTimeValueL, EFnDateAndTime,    1,  0x00, 0},    
    {&ShgFormula::FnYearL,      EFnDateAndTime,   1,   0x00,    0}, 


    {&ShgFormula::FnAbsL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnACosL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnASinL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnATanL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnATan2L,     EFnMathematical,2, 0x00,  0},   
    {&ShgFormula::FnCosL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnDegreesL,   EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnExpL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnFactL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnIntL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnLnL,        EFnMathematical,1,  0x00, 0},    
    {&ShgFormula::FnLog10L,     EFnMathematical,1, 0x00,  0},   
    {&ShgFormula::FnModL,       EFnMathematical,2,   0x00,    0}, 
    {&ShgFormula::FnPiL,        EFnMathematical,0,  0x00, 0},    
    {&ShgFormula::FnRadiansL,   EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnRandL,      EFnMathematical,0,    0x00,   0},  
    {&ShgFormula::FnRoundL,     EFnMathematical,2, 0x00,  0},   
    {&ShgFormula::FnSignL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnSinL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnSqrtL,      EFnMathematical,1,    0x00,   0},  
    {&ShgFormula::FnSumProductL,EFnMathematical,2,  0x05, 0},    
    {&ShgFormula::FnTanL,       EFnMathematical,1,   0x00,    0}, 
    {&ShgFormula::FnTruncL,     EFnMathematical,1, 0x00,  0},   


    {&ShgFormula::FnCTermL,     EFnFinancial,  3,    0x00,   0},  
    {&ShgFormula::FnDdbL,       EFnFinancial,    4,  0x00, 0},    
    {&ShgFormula::FnFvL,        EFnFinancial,   3,   0x00,    0}, 
    {&ShgFormula::FnIrrL,       EFnFinancial,    2,  0x04, 0},    
    {&ShgFormula::FnNpvL,       EFnFinancial,    2,  0x08, 0},    
    {&ShgFormula::FnPmtL,       EFnFinancial,    3,  0x00, 0},    
    {&ShgFormula::FnPvL,        EFnFinancial,   3,   0x00,    0}, 
    {&ShgFormula::FnRateL,      EFnFinancial, 3, 0x00,  0},   
    {&ShgFormula::FnSlnL,       EFnFinancial,    3,  0x00, 0},    
    {&ShgFormula::FnSydL,       EFnFinancial,    4,  0x00, 0},    
    {&ShgFormula::FnTermL,      EFnFinancial, 3, 0x00,  0},   


    {&ShgFormula::FnCombinL,    EFnStatistical, 2,  0x00, 0},    
    {&ShgFormula::FnPermutL,    EFnStatistical, 2,  0x00, 0},    


    {&ShgFormula::FnOpPowerL,   EFnMathematical, 2, 0,     0}, 


    {&ShgFormula::FnAverageBeginL,  EFnStatistical,   0xff,    0x02,   0},  
    {&ShgFormula::FnChooseBeginL,   EFnStatistical,  0xff, 0x00,  0},   
    {&ShgFormula::FnCountBeginL,    EFnStatistical, 0xff,  0x02, 0},    
    {&ShgFormula::FnCountABeginL,   EFnStatistical,  0xff, 0x02,  0},   
    {&ShgFormula::FnCountBlankBeginL,EFnStatistical,0xff,   0x02,    0}, 
    {&ShgFormula::FnMaxBeginL,      EFnStatistical,   0xff,    0x02,   0},  
    {&ShgFormula::FnMinBeginL,      EFnStatistical,   0xff,    0x02,   0},  
    {&ShgFormula::FnProductBeginL,  EFnStatistical,   0xff,    0x02,   0},  
    {&ShgFormula::FnStdevPBeginL,   EFnStatistical,  0xff, 0x02,  0},   
    {&ShgFormula::FnStdevBeginL,    EFnStatistical, 0xff,  0x02, 0},    
    {&ShgFormula::FnSumBeginL,      EFnStatistical,   0xff,    0x02,   0},  
    {&ShgFormula::FnSumSqBeginL,    EFnStatistical, 0xff,  0x02,     0}, 
    {&ShgFormula::FnVarPBeginL,     EFnStatistical,    0xff,   0x02,    0},  
    {&ShgFormula::FnVarBeginL,      EFnStatistical,   0xff,    0x02,   0},   


    
    };

Description