@specs-feup/lara/api/lara/pass/SimplePass.d.ts

A js port of the popular framework for building source-to-source compilers

import { LaraJoinPoint } from "../../LaraJoinPoint.js";
import TraversalType from "../../weaver/TraversalType.js";
import Pass from "./Pass.js";
import AggregatePassResult from "./results/AggregatePassResult.js";
import PassResult from "./results/PassResult.js";
/**
 * Represents a Lara transformation pass.
 *
 * Need to implement:
 *  - matchJoinpoint($jp)
 *  - transformJoinpoint($jp)
 */
export default abstract class SimplePass extends Pass {
    protected _traversalType: TraversalType;
    /**
     * @param includeDescendants - Apply pass to the join point's descendents
     */
    constructor(includeDescendants?: boolean);
    /**
     * Should the Pass be applied to the join point's descendants
     *
     */
    private includeDescendants;
    /**
     * Order in which the join point's descendants should be visited
     *
     */
    get traversalType(): TraversalType;
    /**
     * Selects the join points and its descendants, if needed, according to the traversalType
     * @param $jp - The point in the code from which to select
     * @returns Array of join points selected
     */
    _selectedJps($jp: LaraJoinPoint): LaraJoinPoint[];
    /**
     * Apply tranformation to
     *
     * @param $jp - Joinpoint on which the pass will be applied
     * @returns Results of applying this pass to the given joinpoint
     */
    _apply_impl($jp: LaraJoinPoint): AggregatePassResult;
    /**
     * Predicate that informs the pass whether a certain joinpoint should be transformed
     *
     * @param $jp - Join point to match
     * @returns Returns true if the joinpoint matches the predicate for this pass
     */
    abstract matchJoinpoint($jp: LaraJoinPoint): boolean;
    /**
     * Transformation to be applied to matching joinpoints
     *
     * @param $jp - Join point to transform
     * @returns The result of the transformation
     */
    abstract transformJoinpoint($jp: LaraJoinPoint): PassResult | never;
}
//# sourceMappingURL=SimplePass.d.ts.map