ECExpressions.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "ECInstanceIterable.h"
#include "ECInstance.h"


#define EXPR_TYPEDEFS(_name_)  \
        BEGIN_BENTLEY_ECOBJECT_NAMESPACE      \
            struct _name_;      \
            typedef _name_ *         _name_##P;  \
            typedef _name_ &         _name_##R;  \
            typedef _name_ const*    _name_##CP; \
            typedef _name_ const&    _name_##CR; \
        END_BENTLEY_ECOBJECT_NAMESPACE

EXPR_TYPEDEFS(ArgumentTreeNode)
EXPR_TYPEDEFS(ArithmeticNode)
EXPR_TYPEDEFS(UnitSpecNode)
EXPR_TYPEDEFS(BinaryNode)
EXPR_TYPEDEFS(CallNode)
EXPR_TYPEDEFS(LambdaNode)
EXPR_TYPEDEFS(ComparisonNode)
EXPR_TYPEDEFS(ConcatenateNode)
EXPR_TYPEDEFS(ContextSymbol)
EXPR_TYPEDEFS(CustomSymbol)
EXPR_TYPEDEFS(DivideNode)
EXPR_TYPEDEFS(DotNode)
EXPR_TYPEDEFS(ErrorNode)
EXPR_TYPEDEFS(EvaluationResult)
EXPR_TYPEDEFS(ExpressionContext)
EXPR_TYPEDEFS(ExpressionResolver)
EXPR_TYPEDEFS(ExpressionType)
EXPR_TYPEDEFS(IValueListResult)
EXPR_TYPEDEFS(LambdaValue)
EXPR_TYPEDEFS(IdentNode)
EXPR_TYPEDEFS(IIfNode)
EXPR_TYPEDEFS(InstanceListExpressionContext)
EXPR_TYPEDEFS(InstanceExpressionContext)
EXPR_TYPEDEFS(LBracketNode)
EXPR_TYPEDEFS(Lexer)
EXPR_TYPEDEFS(LogicalNode)
EXPR_TYPEDEFS(MethodReference)
EXPR_TYPEDEFS(MethodSymbol)
EXPR_TYPEDEFS(MultiplyNode)
EXPR_TYPEDEFS(Node)
EXPR_TYPEDEFS(NodeVisitor)
EXPR_TYPEDEFS(PlusMinusNode)
EXPR_TYPEDEFS(PrimaryListNode)
EXPR_TYPEDEFS(ReferenceResult)
EXPR_TYPEDEFS(ResolvedTypeNode)
EXPR_TYPEDEFS(ShiftNode)
EXPR_TYPEDEFS(Symbol)
EXPR_TYPEDEFS(SymbolExpressionContext)
EXPR_TYPEDEFS(UnaryArithmeticNode)
EXPR_TYPEDEFS(ValueResult)
EXPR_TYPEDEFS(ValueSymbol)
EXPR_TYPEDEFS(IECSymbolProvider)

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

typedef RefCountedPtr<ArgumentTreeNode>             ArgumentTreeNodePtr;
typedef RefCountedPtr<CallNode>                     CallNodePtr;
typedef RefCountedPtr<LambdaNode>                   LambdaNodePtr;
typedef RefCountedPtr<ContextSymbol>                ContextSymbolPtr;
typedef RefCountedPtr<DotNode>                      DotNodePtr;
typedef RefCountedPtr<ErrorNode>                    ErrorNodePtr;
typedef RefCountedPtr<ExpressionType>               ExpressionTypePtr;
typedef RefCountedPtr<IValueListResult>             IValueListResultPtr;
typedef RefCountedPtr<LambdaValue>                  LambdaValuePtr;
typedef RefCountedPtr<ExpressionContext>            ExpressionContextPtr;
typedef RefCountedPtr<IdentNode>                    IdentNodePtr;
typedef RefCountedPtr<UnitSpecNode>                 UnitSpecNodePtr;
typedef RefCountedPtr<InstanceListExpressionContext> InstanceListExpressionContextPtr;
typedef RefCountedPtr<InstanceExpressionContext>    InstanceExpressionContextPtr;
typedef RefCountedPtr<LBracketNode>                 LBracketNodePtr;
typedef RefCountedPtr<Lexer>                        LexerPtr;
typedef RefCountedPtr<MethodReference>              MethodReferencePtr;
typedef RefCountedPtr<MethodSymbol>                 MethodSymbolPtr;
typedef RefCountedPtr<Node>                         NodePtr;
typedef RefCountedPtr<PrimaryListNode>              PrimaryListNodePtr;
typedef RefCountedPtr<ResolvedTypeNode>             ResolvedTypeNodePtr;
typedef RefCountedPtr<Symbol>                       SymbolPtr;
typedef RefCountedPtr<SymbolExpressionContext>      SymbolExpressionContextPtr;
typedef RefCountedPtr<ValueResult>                  ValueResultPtr;
typedef RefCountedPtr<ValueSymbol>                  ValueSymbolPtr;

typedef bvector<NodeP>                              NodeVector;
typedef bvector<NodeCP>                             NodeCPVector;
typedef NodeVector::iterator                        NodeVectorIterator;

typedef bvector<NodePtr>                            NodePtrVector;
typedef NodePtrVector::iterator                     NodePtrVectorIterator;

typedef bvector<EvaluationResult>                   EvaluationResultVector;
typedef EvaluationResultVector::iterator            EvaluationResultVectorIterator;


typedef ExpressionStatus (*ExpressionStaticMethod_t)(EvaluationResult& evalResult, EvaluationResultVector& arguments);
typedef ExpressionStatus (*ExpressionInstanceMethod_t)(EvaluationResult& evalResult, ECInstanceListCR instanceList, EvaluationResultVector& arguments);
// NB: We could generalize Instance methods to take any EvaluationResult as the calling object, but we'd have to refactor all our existing instance method implementations to
// check that the caller is an ECInstanceList...rather keep value list methods separate from instance list methods...
typedef ExpressionStatus (*ExpressionValueListMethod_t)(EvaluationResult& evalResult, IValueListResultCR valueList, EvaluationResultVector& arguments);





/*=================================================================================**/
struct          ExpressionContext : RefCountedBase
{

    ECOBJECTS_EXPORT bool               AllowsTypeConversion() const;

    ECOBJECTS_EXPORT bool               EnforcesUnits() const;

    ECOBJECTS_EXPORT bool               EnforceGlobalRepresentation () const;

    ECOBJECTS_EXPORT EvaluationOptions  GetEvaluationOptions() const;

    ECOBJECTS_EXPORT void               SetEvaluationOptions (EvaluationOptions options);
}; // End of class ExpressionContext

//=================================================================================//
//+===============+===============+===============+===============+===============+======//
struct          InstanceListExpressionContext : ExpressionContext
    {
public:
    ECOBJECTS_EXPORT static InstanceListExpressionContextPtr    Create (bvector<IECInstancePtr> const& instances, ExpressionContextP outer = NULL);
    };

/*---------------------------------------------------------------------------------**/
struct InstanceExpressionContext : InstanceListExpressionContext
    {
public:
    ECOBJECTS_EXPORT static InstanceExpressionContextPtr        Create (ExpressionContextP outer = NULL);
    
    ECOBJECTS_EXPORT void           SetInstance (IECInstanceCR instance);

    ECOBJECTS_EXPORT void           SetInstances (ECInstanceListCR instances);
    };

/*=================================================================================**/
struct          SymbolExpressionContext : ExpressionContext
{
public:
    ECOBJECTS_EXPORT BentleyStatus  AddSymbol (SymbolR symbol);
    ECOBJECTS_EXPORT static SymbolExpressionContextPtr Create(ExpressionContextP outer);
}; // End of class SymbolExpressionContext


/*=================================================================================**/
struct          Symbol : RefCountedBase
{

};  // End of class Symbol

/*=================================================================================**/
struct          ContextSymbol : Symbol
{

public:
    ECOBJECTS_EXPORT static ContextSymbolPtr        CreateContextSymbol(wchar_t const* name, ExpressionContextR context);
};

/*=================================================================================**/
struct          MethodSymbol : Symbol
{
public:
    ECOBJECTS_EXPORT static MethodSymbolPtr    Create(wchar_t const* name, ExpressionStaticMethod_t staticMethod, ExpressionInstanceMethod_t instanceMethod);
};


enum            ExpressionToken
    {
    TOKEN_None                = 0,
    TOKEN_Null                = 16,               // Null
    TOKEN_True                = 17,
    TOKEN_False               = 18,
    TOKEN_Like                = 19,
    TOKEN_Is                  = 20,
    TOKEN_Star                = 40,
    TOKEN_Plus                = 41,
    TOKEN_Minus               = 42,
    TOKEN_Slash               = 43,               //  /
    TOKEN_Comma               = 44,               //  ,
    TOKEN_IntegerDivide       = 45,               //  \ -- backslash
    TOKEN_LParen              = 46,               //  (
    TOKEN_RParen              = 47,               //  )
    TOKEN_Exponentiation      = 48,               //  ^
    TOKEN_And                 = 50,               //  And
    TOKEN_AndAlso             = 51,               //  AndAlso -- short circuiting And
    TOKEN_Or                  = 52,               //  Or
    TOKEN_OrElse              = 53,               //  OrElse -- short circuiting Or
    TOKEN_Concatenate         = 54,
    TOKEN_Mod                 = 55,               //  Mod
    TOKEN_ShiftLeft           = 56,               //  <<
    TOKEN_ShiftRight          = 57,               //  >>
    TOKEN_Colon               = 58,               //  : decorates a sub-expression with a unit specification ("expr:UnitName[::Factor[::Offset]]")
    TOKEN_LessEqual           = 59,
    TOKEN_GreaterEqual        = 60,
    TOKEN_Less                = 61,
    TOKEN_Greater             = 62,
    TOKEN_Equal               = 63,
    TOKEN_NotEqual            = 64,               //      <>
    TOKEN_Not                 = 65,               //      "Not"
    TOKEN_Xor                 = 66,               //      "Xor"
    TOKEN_UnsignedShiftRight  = 68,               //  >>>
    TOKEN_LeftBracket         = 69,               //      [
    TOKEN_RightBracket        = 70,               //      ]
    TOKEN_Dot                 = 71,               //      .
    TOKEN_IIf                 = 72,               //      IFF
    TOKEN_LCurly              = 73,               //      {
    TOKEN_RCurly              = 74,               //      }

    TOKEN_If                  = 75,
    TOKEN_Else                = 76,
    TOKEN_ElseIf              = 77,
    TOKEN_Select              = 78,
    TOKEN_End                 = 79,
    TOKEN_EndIf               = 80,

    TOKEN_Lambda              = 85,               // => e.g. "SomeArray.Select (X => X.Name)", "SomeArray.AnyMatches (val => val > 10)"

    TOKEN_DoubleColon         = 100,

    TOKEN_Error               = 181,
    TOKEN_Ident               = 182,
    TOKEN_StringConst         = 183,
    TOKEN_PointConst          = 184,
    TOKEN_DateTimeConst       = 185,               //      @
    TOKEN_IntegerConstant     = 187,
    TOKEN_HexConstant         = 188,
    TOKEN_FloatConst          = 189,
    TOKEN_UnitsConst          = 190,               // what is this used for...anything...?
    TOKEN_Unrecognized        = 200,
    TOKEN_BadNumber           = 201,
    TOKEN_BadOctalNumber      = 202,
    TOKEN_BadHexNumber        = 203,
    TOKEN_BadFloatingPointNumber = 204,
    TOKEN_UnterminatedString   = 205,
    TOKEN_PrimaryList         = 206,
    };


/*=================================================================================**/
struct          ValueSymbol : Symbol
{
    ECOBJECTS_EXPORT static ValueSymbolPtr    Create(wchar_t const* name, ECN::ECValueCR exprValue);

};  //  End of ValueSymbol

/*=================================================================================**/
struct          NodeVisitor 
{
    virtual     ~NodeVisitor() {}
    virtual bool OpenParens() = 0;
    virtual bool CloseParens() = 0;
    virtual bool StartArrayIndex(NodeCR node) = 0;
    virtual bool EndArrayIndex(NodeCR node) = 0;
    virtual bool StartArguments(NodeCR node) = 0;
    virtual bool EndArguments(NodeCR node) = 0;
    virtual bool Comma() = 0;
    virtual bool ProcessNode(NodeCR node) = 0;
    virtual bool ProcessUnits (UnitSpecCR units) = 0;
};

/*=================================================================================**/
struct          ECEvaluator
    {
public:
    ECOBJECTS_EXPORT static NodePtr  ParseValueExpressionAndCreateTree(wchar_t const* expression);
    ECOBJECTS_EXPORT static NodePtr  ParseAssignmentExpressionAndCreateTree(wchar_t const* expression);

};  // End of ECEvaluator class

/*=================================================================================**/
struct          ValueResult : RefCountedBase
{
    ECOBJECTS_EXPORT ExpressionStatus  GetECValue (ECN::ECValueR ecValue);
};

/*=================================================================================**/
struct          ExpressionResolver : RefCountedBase
{
private:
    ExpressionContextPtr m_context;

protected:
    ExpressionStatus PerformArithmeticPromotion(ECN::PrimitiveType&targetType, ResolvedTypeNodePtr& left, ResolvedTypeNodePtr& right);
    ExpressionStatus PerformJunctionPromotion(ECN::PrimitiveType&targetType, ResolvedTypeNodePtr& left, ResolvedTypeNodePtr& right);
    ExpressionStatus PromoteToType(ResolvedTypeNodePtr& node, ECN::PrimitiveType targetType);
    ExpressionStatus PromoteToString(ResolvedTypeNodePtr& node);
    ExpressionResolver(ExpressionContextR context) { m_context = &context; }

public:
    ExpressionContextCR GetExpressionContext() const { return *m_context; }
    ExpressionContextR GetExpressionContextR() const { return *m_context; }

    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolvePrimaryList (PrimaryListNodeR primaryList);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveUnaryArithmeticNode (UnaryArithmeticNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveMultiplyNode (MultiplyNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveDivideNode (DivideNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolvePlusMinusNode (PlusMinusNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveConcatenateNode (ConcatenateNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveComparisonNode (ComparisonNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveLogicalNode (LogicalNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveShiftNode (ShiftNodeCR node);
    ECOBJECTS_EXPORT virtual ResolvedTypeNodePtr _ResolveIIfNode (IIfNodeCR node);
};

/*=================================================================================**/
struct          Node : RefCountedBase
{
public:
    ECOBJECTS_EXPORT ResolvedTypeNodePtr  GetResolvedTree(ExpressionResolverR context);

    ECOBJECTS_EXPORT ExpressionStatus GetValue(ValueResultPtr& valueResult, ExpressionContextR context);

    ECOBJECTS_EXPORT bool  Traverse(NodeVisitorR visitor) const;

    ECOBJECTS_EXPORT WString  ToString() const;

    ECOBJECTS_EXPORT WString  ToExpressionString() const;
};  //  End of struct Node

END_BENTLEY_ECOBJECT_NAMESPACE