block.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
 
#pragma once
 
#include "entity.h"
#include "blockprototype.h"
 
namespace libscratchcpp
{
 
class IEngine;
class Target;
class CompilerValue;
class Input;
class Field;
class Comment;
class InputValue;
class BlockPrivate;

class LIBSCRATCHCPP_EXPORT Block
    : public Entity
    , public std::enable_shared_from_this<Block>
{
    public:
        Block(const std::string &id, const std::string &opcode, bool isMonitorBlock = false);
        Block(const Block &) = delete;
 
        CompilerValue *compile(Compiler *compiler);
 
        const std::string &opcode() const;
 
        Block *next() const;
        const std::string &nextId() const;
        void setNext(Block *block);
        void setNextId(const std::string &nextId);
 
        Block *parent() const;
        const std::string &parentId() const;
        void setParent(Block *block);
        void setParentId(const std::string &id);
 
        const std::vector<std::shared_ptr<Input>> &inputs() const;
        int addInput(std::shared_ptr<Input> input);
        std::shared_ptr<Input> inputAt(int index) const;
        int findInput(const std::string &inputName) const;
 
        const std::vector<std::shared_ptr<Field>> &fields() const;
        int addField(std::shared_ptr<Field> field);
        std::shared_ptr<Field> fieldAt(int index) const;
        int findField(const std::string &fieldName) const;
 
        bool shadow() const;
        void setShadow(bool newShadow);
 
        bool topLevel() const;
 
        int x() const;
        void setX(int x);
 
        int y() const;
        void setY(int y);
 
        std::shared_ptr<Comment> comment() const;
        const std::string &commentId() const;
        void setComment(std::shared_ptr<Comment> comment);
        void setCommentId(const std::string &commentId);
 
        void setEngine(IEngine *newEngine);
        IEngine *engine() const;
 
        void setTarget(Target *newTarget);
        Target *target() const;
 
        BlockComp compileFunction() const;
        void setCompileFunction(BlockComp newCompileFunction);
 
        HatPredicateCompileFunc hatPredicateCompileFunction() const;
        void setHatPredicateCompileFunction(HatPredicateCompileFunc newHatPredicateCompileFunction);
 
        bool mutationHasNext() const;
        void setMutationHasNext(bool newMutationHasNext);
 
        BlockPrototype *mutationPrototype();
 
        bool isTopLevelReporter() const;
        void setIsTopLevelReporter(bool isTopLevelReporter);
 
        InputValue *topLevelReporterInfo();
 
        bool isMonitorBlock() const;
 
    private:
        spimpl::unique_impl_ptr<BlockPrivate> impl;
};
 
} // namespace libscratchcpp