All files / src/node NodeUtils.ts

98.57% Statements 69/70
96.3% Branches 52/54
100% Functions 5/5
98.57% Lines 69/70
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 2261x 1x 1x           1x   1x 1x   1x       1x                         3638x   17793x             3638x               3637x   3637x 3637x   3637x               1x   1x 1x         1x               4x 4x 3x 1x     2x     1x               739892x 739892x   739892x 1x     739891x 149365x       149365x 139507x       739891x 629871x     110020x   110020x               48x 48x   48x 1x     47x 11x     36x 13x     23x               4x 1x     3x               33353x   33353x   881233x   881233x 33353x 9906x   23447x 23447x     33353x   847880x     881233x 881233x       33353x                         3638x                         37582x   37582x   234481x 33945x       234481x 17793x            
import * as escodegen from 'escodegen';
import * as esprima from 'esprima';
import * as estraverse from 'estraverse';
import * as ESTree from 'estree';
 
import { TNodeWithBlockStatement } from '../types/node/TNodeWithBlockStatement';
import { TStatement } from '../types/node/TStatement';
 
import { NodeType } from '../enums/NodeType';
 
import { Node } from './Node';
import { Nodes } from './Nodes';
 
export class NodeUtils {
    /**
     * @type {string[]}
     */
    private static readonly nodesWithBlockScope: string[] = [
        NodeType.ArrowFunctionExpression,
        NodeType.FunctionDeclaration,
        NodeType.FunctionExpression,
        NodeType.MethodDefinition,
        NodeType.Program
    ];
 
    /**
     * @param astTree
     * @return {T}
     */
    public static addXVerbatimPropertyToLiterals <T extends ESTree.Node> (astTree: T): T {
        NodeUtils.typedReplace(astTree, NodeType.Literal, {
            leave: (literalNode: ESTree.Literal) => {
                literalNode['x-verbatim-property'] = {
                    content : literalNode.raw,
                    precedence: escodegen.Precedence.Primary
                };
            }
        });
 
        return astTree;
    }
 
    /**
     * @param code
     * @returns {TStatement[]}
     */
    public static convertCodeToStructure (code: string): TStatement[] {
        let structure: ESTree.Program = esprima.parse(code);
 
        structure = NodeUtils.addXVerbatimPropertyToLiterals(structure);
        structure = NodeUtils.parentize(structure);
 
        return <TStatement[]>structure.body;
    }
 
    /**
     * @param structure
     * @returns {string}
     */
    public static convertStructureToCode (structure: ESTree.Node[]): string {
        let code: string = '';
 
        structure.forEach((node: ESTree.Node) => {
            code += escodegen.generate(node, {
                sourceMapWithCode: true
            }).code;
        });
 
        return code;
    }
 
    /**
     * @param node
     * @param index
     * @returns {ESTree.Node}
     */
    public static getBlockStatementNodeByIndex (node: ESTree.Node, index: number = 0): ESTree.Node {
        if (Node.isNodeHasBlockStatement(node)) {
            if (node.body[index] === undefined) {
                throw new ReferenceError(`Wrong index \`${index}\`. Block-statement body length is \`${node.body.length}\``);
            }
 
            return node.body[index];
        }
 
        throw new TypeError('The specified node have no a block-statement');
    }
 
    /**
     * @param node
     * @param blockScopes
     * @returns {ESTree.Node}
     */
    public static getBlockScopesOfNode (node: ESTree.Node, blockScopes: TNodeWithBlockStatement[] = []): TNodeWithBlockStatement[] {
        const parentNode: ESTree.Node | undefined = node.parentNode;
 
        if (!parentNode) {
            throw new ReferenceError('`parentNode` property of given node is `undefined`');
        }
 
        if (Node.isBlockStatementNode(parentNode)) {
            Iif (!parentNode.parentNode) {
                throw new ReferenceError('`parentNode` property of `parentNode` of given node is `undefined`');
            }
 
            if (NodeUtils.nodesWithBlockScope.includes(parentNode.parentNode.type)) {
                blockScopes.push(parentNode);
            }
        }
 
        if (!Node.isProgramNode(parentNode)) {
            return NodeUtils.getBlockScopesOfNode(parentNode, blockScopes);
        }
 
        blockScopes.push(parentNode);
 
        return blockScopes;
    }
 
    /**
     * @param node
     * @param depth
     * @returns {number}
     */
    public static getNodeBlockScopeDepth (node: ESTree.Node, depth: number = 0): number {
        const parentNode: ESTree.Node | undefined = node.parentNode;
 
        if (!parentNode) {
            throw new ReferenceError('`parentNode` property of given node is `undefined`');
        }
 
        if (Node.isProgramNode(parentNode)) {
            return depth;
        }
 
        if (Node.isBlockStatementNode(node) && NodeUtils.nodesWithBlockScope.includes(parentNode.type)) {
            return NodeUtils.getNodeBlockScopeDepth(parentNode, ++depth);
        }
 
        return NodeUtils.getNodeBlockScopeDepth(parentNode, depth);
    }
 
    /**
     * @param unaryExpressionNode
     * @returns {ESTree.Node}
     */
    public static getUnaryExpressionArgumentNode (unaryExpressionNode: ESTree.UnaryExpression): ESTree.Node {
        if (Node.isUnaryExpressionNode(unaryExpressionNode.argument)) {
            return NodeUtils.getUnaryExpressionArgumentNode(unaryExpressionNode.argument);
        }
 
        return unaryExpressionNode.argument;
    }
 
    /**
     * @param astTree
     * @return {T}
     */
    public static parentize <T extends ESTree.Node> (astTree: T): T {
        let isRootNode: boolean = true;
 
        estraverse.traverse(astTree, {
            enter: (node: ESTree.Node, parentNode: ESTree.Node): any => {
                let value: ESTree.Node;
 
                if (isRootNode) {
                    if (node.type === NodeType.Program) {
                        value = node;
                    } else {
                        value = Nodes.getProgramNode(<TStatement[]>[node]);
                        value.parentNode = value;
                    }
 
                    isRootNode = false;
                } else {
                    value = parentNode || node;
                }
 
                node.parentNode = value;
                node.obfuscatedNode = false;
            }
        });
 
        return astTree;
    }
 
    /**
     * @param astTree
     * @param nodeType
     * @param visitor
     */
    public static typedReplace (
        astTree: ESTree.Node,
        nodeType: string,
        visitor: {enter?: (node: ESTree.Node) => void, leave?: (node: ESTree.Node) => void},
    ): void {
        NodeUtils.typedTraverse(astTree, nodeType, visitor, 'replace');
    }
 
    /**
     * @param astTree
     * @param nodeType
     * @param visitor
     * @param traverseType
     */
    public static typedTraverse (
        astTree: ESTree.Node,
        nodeType: string,
        visitor: estraverse.Visitor,
        traverseType: string = 'traverse'
    ): void {
        (<any>estraverse)[traverseType](astTree, {
            enter: (node: ESTree.Node, parentNode: ESTree.Node): any => {
                if (node.type === nodeType && visitor.enter) {
                    return visitor.enter(node, parentNode);
                }
            },
            leave: (node: ESTree.Node, parentNode: ESTree.Node): any => {
                if (node.type === nodeType && visitor.leave) {
                    return visitor.leave(node, parentNode);
                }
            }
        });
    }
}