LogicDeclaration 逻辑声明

1. 结构声明

TS Declaration

class LogicDeclaration extends BaseNode {
    name: string = '';
    title: string;
    description: string;
    typeParams?: Array<TypeParam>;
    params: Array<Param>;
    returns: Array<Return>;
}

JSON Schema

{
    "type": "object",
    "properties": {
        "composedBy": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "name": {
            "type": "string"
        },
        "title": {
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "typeParams": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/TypeParam"
            }
        },
        "params": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Param"
            }
        },
        "returns": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Return"
            }
        }
    },
    "required": [
        "name",
        "title",
        "description",
        "params",
        "returns"
    ],
    "additionalProperties": false
}

2. 节点示例

(1) 示例

AST 如下：

JSON

{
    "concept": "LogicDeclaration",
    "name": "exportExcel",
    "title": "导出Excel",
    "description": "传入数据，导出Excel",
    "params": [
        {
            "concept": "Param",
            "name": "size",
            "typeAnnotation": {
                "concept": "TypeAnnotation",
                "typeKind": "primitive",
                "typeNamespace": "nasl.core",
                "typeName": "Long",
                "inferred": false,
                "ruleMap": {}
            },
            "description": "数据量"
        }
    ],
    "returns": [
        {
            "concept": "Return",
            "name": "result",
            "typeAnnotation": {
                "concept": "TypeAnnotation",
                "typeKind": "primitive",
                "typeNamespace": "nasl.core",
                "typeName": "Boolean",
                "inferred": false,
                "ruleMap": {}
            },
            "description": "导出是否成功"
        }
    ]
}

YAML

concept: LogicDeclaration
name: exportExcel
title: 导出Excel
description: 传入数据，导出Excel
params:
  - concept: Param
    name: size
    typeAnnotation:
      concept: TypeAnnotation
      typeKind: primitive
      typeNamespace: nasl.core
      typeName: Long
      inferred: false
      ruleMap: {}
    description: 数据量
returns:
  - concept: Return
    name: result
    typeAnnotation:
      concept: TypeAnnotation
      typeKind: primitive
      typeNamespace: nasl.core
      typeName: Boolean
      inferred: false
      ruleMap: {}
    description: 导出是否成功

对应的代码如下：

文本化 NASL

logic exportExcel(size: Integer) => result: Boolean;