@specs-feup/alpakka/src-api/alpakka/graphs/cfg/flow/node/instruction/InstructionNode.ts

A Smali/APK source-to-source compiler written in Typescript

import ControlFlowEdge from "../../edge/ControlFlowEdge.js";
import FlowNode from "../FlowNode.js";
import BaseEdge from "../../../graph/BaseEdge.js";
import BaseNode from "../../../graph/BaseNode.js";
import { NodeBuilder, NodeTypeGuard } from "../../../graph/Node.js";
import { Joinpoint } from "../../../../../../Joinpoints.js";

namespace InstructionNode {
  export class Class<
    D extends Data = Data,
    S extends ScratchData = ScratchData,
  > extends FlowNode.Class<D, S> {
    get nextEdge(): ControlFlowEdge.Class | undefined {
      if (this.data.nextEdgeId === undefined) {
        return undefined;
      }
      // Data and scratchdata should be BaseEdge
      const edge = this.graph.getEdgeById(this.data.nextEdgeId);

      if (edge === undefined) {
        // this.data.nextEdgeId = undefined;
        return undefined;
      }

      return (
        edge as BaseEdge.Class<
          ControlFlowEdge.Data,
          ControlFlowEdge.ScratchData
        >
      ).as(ControlFlowEdge.Class);
    }

    get nextNode(): FlowNode.Class | undefined {
      const node = this.nextEdge?.target;
      if (node === undefined || !node.is(FlowNode.TypeGuard)) {
        return undefined;
      }
      return node.as(FlowNode.Class);
    }

    set nextNode(node: FlowNode.Class | undefined) {
      const edge = this.nextEdge;

      if (edge !== undefined && node !== undefined) {
        edge.target = node;
      } else if (edge !== undefined && node === undefined) {
        edge.remove();
        this.data.nextEdgeId = undefined;
      } else if (edge === undefined && node !== undefined) {
        const newEdge = this.graph
          .addEdge(this, node)
          .init(new ControlFlowEdge.Builder());

        this.data.nextEdgeId = newEdge.id;
      }
    }
  }

  export abstract class Builder
    extends FlowNode.Builder
    implements NodeBuilder<Data, ScratchData>
  {
    #instructionFlowNodeType: Type;

    constructor(type: Type, $jp?: Joinpoint) {
      super(FlowNode.Type.INSTRUCTION, $jp);
      this.#instructionFlowNodeType = type;
    }

    buildData(data: BaseNode.Data): Data {
      return {
        ...(super.buildData(data) as FlowNode.Data & {
          flowNodeType: FlowNode.Type.INSTRUCTION;
        }),
        instructionFlowNodeType: this.#instructionFlowNodeType,
        nextEdgeId: undefined,
      };
    }

    buildScratchData(scratchData: BaseNode.ScratchData): ScratchData {
      return {
        ...super.buildScratchData(scratchData),
      };
    }
  }

  export const TypeGuard: NodeTypeGuard<Data, ScratchData> = {
    isDataCompatible(data: BaseNode.Data): data is Data {
      if (!FlowNode.TypeGuard.isDataCompatible(data)) return false;
      const d = data as Data;
      if (d.flowNodeType !== FlowNode.Type.INSTRUCTION) return false;
      if (!Object.values(Type).includes(d.instructionFlowNodeType as Type))
        return false;
      return true;
    },

    isScratchDataCompatible(
      scratchData: BaseNode.ScratchData,
    ): scratchData is ScratchData {
      if (!FlowNode.TypeGuard.isScratchDataCompatible(scratchData))
        return false;
      return true;
    },
  };

  export interface Data extends FlowNode.Data {
    flowNodeType: FlowNode.Type.INSTRUCTION;
    instructionFlowNodeType: Type;
    nextEdgeId: string | undefined;
  }

  export interface ScratchData extends FlowNode.ScratchData {}

  // ------------------------------------------------------------

  export enum Type {
    FUNCTION_ENTRY = "function_entry",
    FUNCTION_EXIT = "function_exit",
    STATEMENT = "statement",
    SWITCH = "switch",
    RETURN = "return",
    THROW = "throw",
    LABEL = "label",
    GOTO = "goto",
    UNKNOWN = "unknown",
  }
}

export default InstructionNode;