jpexs-decompiler/libsrc/ffdec_lib/src/com/jpexs/decompiler/graph/GraphSource.java

/*
 *  Copyright (C) 2010-2024 JPEXS, All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.
 */
package com.jpexs.decompiler.graph;

import com.jpexs.decompiler.flash.BaseLocalData;
import com.jpexs.decompiler.flash.action.Action;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Set;

/**
 * Graph source abstract class
 *
 * @author JPEXS
 */
public abstract class GraphSource implements Serializable {

    /**
     * Gets the size of the graph source
     *
     * @return The size of the graph source
     */
    public abstract int size();

    /**
     * Gets the graph source item at the specified position
     *
     * @param pos Position of the graph source item
     * @return The graph source item at the specified position
     */
    public abstract GraphSourceItem get(int pos);

    /**
     * Checks if the graph source is empty
     *
     * @return True if the graph source is empty, false otherwise
     */
    public abstract boolean isEmpty();

    /**
     * Translates the part of the graph source
     *
     * @param graph Graph
     * @param part Graph part
     * @param localData Local data
     * @param stack Translate stack
     * @param start Start position
     * @param end End position
     * @param staticOperation Unused
     * @param path Path
     * @return List of graph target items
     * @throws InterruptedException On interrupt
     * @throws GraphPartChangeException On graph part change
     */
    public abstract List<GraphTargetItem> translatePart(Graph graph, GraphPart part, BaseLocalData localData, TranslateStack stack, int start, int end, int staticOperation, String path) throws InterruptedException, GraphPartChangeException;

    /**
     * Gets the important addresses
     *
     * @return Set of important addresses
     */
    public abstract Set<Long> getImportantAddresses();

    /**
     * Converts instruction at the specified position to string
     *
     * @param pos Position of the instruction
     * @return Instruction as string
     */
    public abstract String insToString(int pos);

    /**
     * Visits the code
     *
     * @param ip Start position
     * @param lastIp Last position
     * @param refs References
     * @param endIp End position
     * @throws InterruptedException On interrupt
     */
    private void visitCode(int ip, int lastIp, HashMap<Integer, List<Integer>> refs, int endIp) throws InterruptedException {
        if (Thread.currentThread().isInterrupted()) {
            throw new InterruptedException();
        }

        boolean debugMode = false;
        while (((endIp == -1) || (ip < endIp)) && (ip < size())) {
            refs.get(ip).add(lastIp);
            lastIp = ip;
            if (refs.get(ip).size() > 1) {
                break;
            }
            GraphSourceItem ins = get(ip);

            if (ins.isIgnored()) {
                ip++;
                continue;
            }
            if (debugMode) {
                System.err.println("visit ip " + ip + " action:" + ins);
            }
            if (ins.isExit()) {
                break;
            }

            if (ins instanceof GraphSourceItemContainer) {
                GraphSourceItemContainer cnt = (GraphSourceItemContainer) ins;
                if (ins instanceof Action) { //TODO: Remove dependency of AVM1
                    long endAddr = ((Action) ins).getAddress() + cnt.getHeaderSize();
                    for (long size : cnt.getContainerSizes()) {
                        if (size != 0) {
                            visitCode(adr2pos(endAddr), ip, refs, adr2pos(endAddr + size));
                        }
                        endAddr += size;
                    }
                    ip = adr2pos(endAddr);
                    continue;
                }

            }

            if (ins.isBranch() || ins.isJump()) {
                List<Integer> branches = ins.getBranches(this);
                for (int b : branches) {
                    if (b >= 0) {
                        visitCode(b, ip, refs, endIp);
                    }
                }
                break;
            }
            ip++;
        }
    }

    /**
     * Visits the code
     *
     * @param alternateEntries Alternate entries
     * @return References
     * @throws InterruptedException On interrupt
     */
    public HashMap<Integer, List<Integer>> visitCode(List<Integer> alternateEntries) throws InterruptedException {
        HashMap<Integer, List<Integer>> refs = new HashMap<>();
        int siz = size();
        for (int i = 0; i < siz; i++) {
            refs.put(i, new ArrayList<>());
        }
        visitCode(0, 0, refs, -1);
        int pos = 0;
        for (int e : alternateEntries) {
            pos++;
            visitCode(e, -pos, refs, -1);
        }
        return refs;
    }

    /**
     * Converts address to position
     *
     * @param adr Address
     * @return Position
     */
    public abstract int adr2pos(long adr);

    /**
     * Converts address to position
     *
     * @param adr Address
     * @param nearest Nearest
     * @return Position
     */
    public abstract int adr2pos(long adr, boolean nearest);

    /**
     * Gets the address after the code
     *
     * @return Address after the code
     */
    public long getAddressAfterCode() {
        if (isEmpty()) {
            return 0;
        }
        long lastAddr = pos2adr(size() - 1);
        return lastAddr + get(size() - 1).getBytesLength();
    }

    /**
     * Converts position to address
     *
     * @param pos Position
     * @return Address
     */
    public abstract long pos2adr(int pos);

    /**
     * Converts position to address
     *
     * @param pos Position
     * @param allowPosAfterCode Allow position after code
     * @return Address
     */
    public final long pos2adr(int pos, boolean allowPosAfterCode) {
        if (pos == size() && allowPosAfterCode) {
            return getAddressAfterCode();
        }
        return pos2adr(pos);
    }
}