ScriptAPI.hpp

浏览该文件的文档.

 
 
#pragma once
 
#include "AstGlobal.h"
#include "AstScript/ExprVisitor.hpp"
#include "AstUtil/StringView.hpp"
 
AST_NAMESPACE_BEGIN
 
 
#define AST_EXPR_EXTRA(CLASS) \
    void accept(ExprVisitor& visitor) override{visitor.visit(*this);};
 
 
#define AST_EXPR(CLASS) \
    AST_OBJECT(CLASS)\
    AST_EXPR_EXTRA(CLASS)
 
enum EOpBinType{
    eAdd,       
    eSub,       
    eMul,       
    eDiv,       
    ePow,       
    eMod,       
 
    eAnd,       
    eOr,        
    eBitOr,     
    eBitAnd,    
    eBitXor,    
    eBitLeftShift,   
    eBitRightShift,  
    eBitURightShift, 
 
    eElemMul,   
    eElemDiv,   
    eElemPow,   
    eElemMod,   
    eElemAnd,   
    eElemOr,    
 
    eLt,        
    eLe,        
    eEq,        
    eGt,        
    eGe,        
    eNe,        
 
    numOpBinType,                 
    invalidOpBin=numOpBinType,   
 
    // 下面的枚举为软件内部使用，不要直接调用
    eCatVertical,       
    eCatHorizontal,     
};
 
enum EOpAssignType{
    eAssign,        
    eDelayAssign,   
    eBindAssign,    
 
    eAddAssign,     
    eSubAssign,     
    eMulAssign,     
    eDivAssign,     
    eModAssign,     
    ePowAssign,     
 
    eElemMulAssign, 
    eElemDivAssign, 
    eElemModAssign, 
    eElemPowAssign, 
    eElemAndAssign, 
    eElemOrAssign,  
 
    numOpAssignType,   
};
 
 
enum EOpUnaryType{
    eNot,       
    eNeg,       
    eInc,       
    eDec,       
    eBitNot,    
    numOpUnaryType,   
 
    // 下面的枚举为软件内部使用，不要直接调用
    eIterate,    
};
 
class Expr;         
class Value;        
class Variable;     
class Macro;        
class Function;     
class Symbol;       
 
 
AST_SCRIPT_API Variable* aNewVariable(StringView name, Expr* expr=nullptr, bool bind = false);
AST_SCRIPT_API Variable* aNewVariable(Expr* expr=nullptr, bool bind = false);
 
AST_SCRIPT_API Symbol* aNewSymbol(StringView name);
 
AST_SCRIPT_CAPI Expr* aNewOpAssign(EOpAssignType op, Expr* left, Expr* right);
 
 
AST_SCRIPT_CAPI Expr* aNewOpBin(EOpBinType op, Expr* left, Expr* right);
 
AST_SCRIPT_CAPI Expr* aNewOpUnary(EOpUnaryType op, Expr* expr);
 
AST_SCRIPT_CAPI Expr* aNewExprCondition(Expr* condition, Expr* thenExpr, Expr* elseExpr=nullptr);
 
 
AST_SCRIPT_CAPI Expr* aNewExprRange(Expr* start, Expr* stop, Expr* step=nullptr);
 
 
AST_SCRIPT_CAPI Value* aNewValueString(StringView value);
 
AST_SCRIPT_CAPI Value* aNewValueInt(int value);
 
AST_SCRIPT_CAPI Value* aNewValueBool(bool value);
 
AST_SCRIPT_CAPI Value* aNewValueDouble(double value);
 
AST_SCRIPT_API Value* aNewValueDict();
 
class Quantity;
 
 
AST_SCRIPT_CAPI Value* aNewValueQuantity(const Quantity& value);
 
AST_SCRIPT_CAPI Value* aValueNull();
 
AST_SCRIPT_CAPI Expr* aParseExpr(StringView script);
 
 
AST_SCRIPT_CAPI Value* aEval(StringView script);
 
AST_SCRIPT_CAPI Value* aEvalExpr(Expr* expr);
 
 
AST_SCRIPT_CAPI bool aValueIsBool(Value* value);
 
AST_SCRIPT_CAPI bool aValueIsDouble(Value* value);
 
AST_SCRIPT_CAPI bool aValueIsInt(Value* value);
 
 
AST_SCRIPT_CAPI bool aValueIsArithmetic(Value* value);
 
AST_SCRIPT_CAPI bool aValueIsString(Value* value);
 
AST_SCRIPT_CAPI bool aValueIsQuantity(Value* value);
 
 
AST_SCRIPT_CAPI double aValueToDouble(Value* value);
 
AST_SCRIPT_CAPI bool aValueUnboxBool(Value* value);
 
 
AST_SCRIPT_CAPI double aValueUnboxDouble(Value* value);
 
 
AST_SCRIPT_CAPI int aValueUnboxInt(Value* value);
 
 
AST_SCRIPT_API Quantity aValueUnboxQuantity(Value* value);
 
 
AST_SCRIPT_API std::string aFormatExpr(Expr* expr, Object* context=nullptr);
 
 
typedef Value* (*OpBinFunc)(Value* left, Value* right);
 
typedef Value* (*OpAssignFunc)(Expr* left, Expr* right);    // right 采用表达式对象，因为需要支持延迟赋值和绑定赋值
 
typedef Value* (*OpUnaryFunc)(Value* value);
 
 
enum {eIterBegin=0};  
 
typedef Value* (*IterateFunc)(Value* value, int& index);
 
 
//  @brief 获取二进制运算函数指针
//  @param op 运算类型
//  @param leftType 左运算数类型
//  @param rightType 右运算数类型
//  @return 运算函数指针
AST_SCRIPT_CAPI OpBinFunc aGetOpBinFunc(EOpBinType op, Class* leftType, Class* rightType);
 
 
//  @brief 获取赋值运算函数指针
//  @param op 运算类型
//  @param leftType 左运算数类型
//  @param rightType 右运算数类型
//  @return 运算函数指针
AST_SCRIPT_CAPI OpAssignFunc aGetOpAssignFunc(EOpAssignType op, Class* leftType, Class* rightType);
 
 
//  @param op 运算类型
//  @param type 运算数类型
//  @return 运算函数指针
AST_SCRIPT_CAPI OpUnaryFunc aGetOpUnaryFunc(EOpUnaryType op, Class* type);
 
 
//  @param type 迭代对象类型
//  @return 迭代函数指针
AST_SCRIPT_CAPI IterateFunc aGetIterateFunc(Class* type);
 
 
AST_SCRIPT_CAPI Value* aDoOpBin(EOpBinType op, Value* left, Value* right);
 
AST_SCRIPT_CAPI Value* aDoOpUnary(EOpUnaryType op, Value* value);
 
 
AST_SCRIPT_CAPI Value* aDoOpAssign(EOpAssignType op, Expr* left, Expr* right);
 
 
AST_SCRIPT_CAPI Value* aIterateBegin(Value* container, int& index);
 
AST_SCRIPT_CAPI Value* aIterateNext(Value* container, int& index);
 
 
// ALIAS
 
#ifndef SWIG
 
A_ALWAYS_INLINE Value* aNewValue(int value)
{
    return aNewValueInt(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(double value)
{
    return aNewValueDouble(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(bool value)
{
    return aNewValueBool(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(const Quantity& value)
{
    return aNewValueQuantity(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(StringView value)
{
    return aNewValueString(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(const std::string& value)
{
    return aNewValueString(value);
}
 
A_ALWAYS_INLINE Value* aNewValue(const char* value)
{
    return aNewValueString(value);
}
 
 
// 通过模板捕获所有其他类型并删除，防止隐式转换为 `bool` 类型
template<typename T>
Value* aNewValue(T) = delete;
 
#endif
 
AST_NAMESPACE_END