etsy/phan

<?php

declare(strict_types=1);

namespace Phan\AST\Visitor;

use AssertionError;
use ast\Node;
use Phan\Debug;

use const STDERR;

/**
 * A visitor of AST nodes based on the node's kind value
 * which does nothing upon visiting a node of any kind
 * @phan-file-suppress PhanPluginUnknownMethodReturnType - TODO: Make this and FlagVisitorImplementation use Phan templates?
 * @phan-file-suppress PhanPluginDescriptionlessCommentOnPublicMethod
 */
abstract class KindVisitorImplementation implements KindVisitor
{

    /**
     * The fallback implementation for node kinds where the subclass visitor
     * didn't override the more specific `visit*()` method.
     */
    abstract public function visit(Node $node);

    /**
     * @param Node $node
     * A node to visit
     */
    public function __invoke(Node $node)
    {
        $fn_name = Element::VISIT_LOOKUP_TABLE[$node->kind] ?? 'handleMissingNodeKind';
        return $this->{$fn_name}($node);
    }

    /**
     * @suppress PhanUnreferencedPublicMethod
     * @suppress PhanPluginRemoveDebugAny deliberate warning for unhandled node kind
     */
    public function handleMissingNodeKind(Node $node)
    {
        \fprintf(STDERR, "Unexpected Node kind. Node:\n%s\n", Debug::nodeToString($node));
        throw new AssertionError('All node kinds must match');
    }

    public function visitArgList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitArray(Node $node)
    {
        return $this->visit($node);
    }

    public function visitArrayElem(Node $node)
    {
        return $this->visit($node);
    }

    public function visitArrowFunc(Node $node)
    {
        return $this->visit($node);
    }

    public function visitAssign(Node $node)
    {
        return $this->visit($node);
    }

    public function visitAssignOp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitAssignRef(Node $node)
    {
        return $this->visit($node);
    }

    // Attributes require AST version 80
    public function visitAttribute(Node $node)
    {
        return $this->visit($node);
    }

    public function visitAttributeList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitAttributeGroup(Node $node)
    {
        return $this->visit($node);
    }

    public function visitBinaryOp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitBreak(Node $node)
    {
        return $this->visit($node);
    }

    public function visitCall(Node $node)
    {
        return $this->visit($node);
    }

    public function visitCast(Node $node)
    {
        return $this->visit($node);
    }

    public function visitCatch(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClass(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClassConst(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClassConstDecl(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClassConstGroup(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClassName(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClosure(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClosureUses(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClosureVar(Node $node)
    {
        return $this->visit($node);
    }

    public function visitConst(Node $node)
    {
        return $this->visit($node);
    }

    public function visitConstDecl(Node $node)
    {
        return $this->visit($node);
    }

    public function visitConstElem(Node $node)
    {
        return $this->visit($node);
    }

    public function visitDeclare(Node $node)
    {
        return $this->visit($node);
    }

    public function visitDim(Node $node)
    {
        return $this->visit($node);
    }

    public function visitDoWhile(Node $node)
    {
        return $this->visit($node);
    }

    public function visitEcho(Node $node)
    {
        return $this->visit($node);
    }

    public function visitEmpty(Node $node)
    {
        return $this->visit($node);
    }

    public function visitEncapsList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitExit(Node $node)
    {
        return $this->visit($node);
    }

    public function visitExprList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitForeach(Node $node)
    {
        return $this->visit($node);
    }

    public function visitFuncDecl(Node $node)
    {
        return $this->visit($node);
    }

    public function visitIsset(Node $node)
    {
        return $this->visit($node);
    }

    public function visitGlobal(Node $node)
    {
        return $this->visit($node);
    }

    public function visitGroupUse(Node $node)
    {
        return $this->visit($node);
    }

    public function visitIf(Node $node)
    {
        return $this->visit($node);
    }

    public function visitIfElem(Node $node)
    {
        return $this->visit($node);
    }

    public function visitInstanceof(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMagicConst(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMethod(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMethodCall(Node $node)
    {
        return $this->visit($node);
    }

    public function visitName(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNamedArg(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNamespace(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNew(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNullsafeMethodCall(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNullsafeProp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitParam(Node $node)
    {
        return $this->visit($node);
    }

    public function visitParamList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPreInc(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPrint(Node $node)
    {
        return $this->visit($node);
    }

    public function visitProp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPropGroup(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPropDecl(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPropElem(Node $node)
    {
        return $this->visit($node);
    }

    public function visitReturn(Node $node)
    {
        return $this->visit($node);
    }

    public function visitStatic(Node $node)
    {
        return $this->visit($node);
    }

    public function visitStaticCall(Node $node)
    {
        return $this->visit($node);
    }

    public function visitStaticProp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitStmtList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitSwitch(Node $node)
    {
        return $this->visit($node);
    }

    public function visitSwitchCase(Node $node)
    {
        return $this->visit($node);
    }

    public function visitSwitchList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMatch(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMatchArm(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMatchArmList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitType(Node $node)
    {
        return $this->visit($node);
    }

    public function visitTypeUnion(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNullableType(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUnaryOp(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUse(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUseElem(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUseTrait(Node $node)
    {
        return $this->visit($node);
    }

    public function visitVar(Node $node)
    {
        return $this->visit($node);
    }

    public function visitWhile(Node $node)
    {
        return $this->visit($node);
    }

    public function visitCatchList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitClone(Node $node)
    {
        return $this->visit($node);
    }

    public function visitConditional(Node $node)
    {
        return $this->visit($node);
    }

    public function visitContinue(Node $node)
    {
        return $this->visit($node);
    }

    public function visitFor(Node $node)
    {
        return $this->visit($node);
    }

    public function visitGoto(Node $node)
    {
        return $this->visit($node);
    }

    public function visitHaltCompiler(Node $node)
    {
        return $this->visit($node);
    }

    public function visitIncludeOrEval(Node $node)
    {
        return $this->visit($node);
    }

    public function visitLabel(Node $node)
    {
        return $this->visit($node);
    }

    public function visitMethodReference(Node $node)
    {
        return $this->visit($node);
    }

    public function visitNameList(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPostDec(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPostInc(Node $node)
    {
        return $this->visit($node);
    }

    public function visitPreDec(Node $node)
    {
        return $this->visit($node);
    }

    public function visitRef(Node $node)
    {
        return $this->visit($node);
    }

    public function visitShellExec(Node $node)
    {
        return $this->visit($node);
    }

    public function visitThrow(Node $node)
    {
        return $this->visit($node);
    }

    public function visitTraitAdaptations(Node $node)
    {
        return $this->visit($node);
    }

    public function visitTraitAlias(Node $node)
    {
        return $this->visit($node);
    }

    public function visitTraitPrecedence(Node $node)
    {
        return $this->visit($node);
    }

    public function visitTry(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUnpack(Node $node)
    {
        return $this->visit($node);
    }

    public function visitUnset(Node $node)
    {
        return $this->visit($node);
    }

    public function visitYield(Node $node)
    {
        return $this->visit($node);
    }

    public function visitYieldFrom(Node $node)
    {
        return $this->visit($node);
    }
}