abstractsyntaxtree.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef STARK_TOOLS_ABSTRACT_SYNTAX_TREE_H
#define STARK_TOOLS_ABSTRACT_SYNTAX_TREE_H

#include "common/array.h"

#include "engines/stark/tools/command.h"

namespace Stark {
namespace Tools {

struct ASTCommand;

struct ASTNode {
    ASTNode(ASTNode *parent);
    virtual ~ASTNode();

    virtual void print(uint depth, DefinitionRegistry *definitions) = 0;

    virtual Common::Array<const ASTCommand *> listCommands(uint16 index) const = 0;

    void findSuccessors(ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const;
    virtual void findSuccessorsIntern(const ASTNode *node, ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const = 0;

    virtual const ASTCommand *getFirstCommand() const = 0;

protected:
    void printWithDepth(uint depth, const Common::String &string) const;

    ASTNode *_parent;
};

struct ASTCommand : public ASTNode, public Command {
    ASTCommand(ASTNode *parent, Command *command, DefinitionRegistry *definitions);

    // ASTNode API
    void print(uint depth, DefinitionRegistry *definitions) override;
    Common::Array<const ASTCommand *> listCommands(uint16 index) const override;
    void findSuccessorsIntern(const ASTNode *node, ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const override;
    const ASTCommand *getFirstCommand() const override;

    Common::String callString(DefinitionRegistry *definitions);
};

struct ASTBlock : public ASTNode {
    ASTBlock(ASTNode *parent);
    ~ASTBlock() override;

    // ASTNode API
    void print(uint depth, DefinitionRegistry *definitions) override;
    Common::Array<const ASTCommand *> listCommands(uint16 index) const override;
    void findSuccessorsIntern(const ASTNode *node, ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const override;
    const ASTCommand *getFirstCommand() const override;

    void addNode(ASTNode *node);

private:
    Common::Array<ASTNode *> _children;
};

struct ASTCondition : public ASTNode {
    ASTCondition(ASTNode *parent);
    ~ASTCondition() override;

    // ASTNode API
    void print(uint depth, DefinitionRegistry *definitions) override;
    Common::Array<const ASTCommand *> listCommands(uint16 index) const override;
    void findSuccessorsIntern(const ASTNode *node, ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const override;
    const ASTCommand *getFirstCommand() const override;

    ASTCommand *condition;
    bool invertedCondition;
    ASTBlock *thenBlock;
    ASTBlock *elseBlock;
};

struct ASTLoop : public ASTNode {
    ASTLoop(ASTNode *parent);
    ~ASTLoop() override;

    // ASTNode API
    void print(uint depth, DefinitionRegistry *definitions) override;
    Common::Array<const ASTCommand *> listCommands(uint16 index) const override;
    void findSuccessorsIntern(const ASTNode *node, ASTNode **follower, ASTNode **trueBranch, ASTNode **falseBranch) const override;
    const ASTCommand *getFirstCommand() const override;

    ASTCommand *condition;
    bool invertedCondition;
    ASTBlock *loopBlock;
};

} // End of namespace Tools
} // End of namespace Stark

#endif // STARK_TOOLS_ABSTRACT_SYNTAX_TREE_H