Package net.mcreator.blockly

Class BlocklyToCode

java.lang.Object

net.mcreator.blockly.BlocklyToCode

All Implemented Interfaces:

IGeneratorProvider, IWorkspaceProvider

Direct Known Subclasses:

BlocklyToJava, BlocklyToJSONTrigger

public abstract class BlocklyToCode
extends Object
implements IGeneratorProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<IBlockGenerator>	blockGenerators
protected final BlocklyEditorType	editorType
protected String	lastProceduralBlockType

Constructor Summary

Constructors

Constructor	Description
BlocklyToCode(Workspace workspace, ModElement parent, BlocklyEditorType editorType, TemplateGenerator templateGenerator, IBlockGenerator... externalGenerators)

Method Summary

Modifier and Type	Method	Description
final void	addCompileNote(BlocklyCompileNote compileNote)
final void	addDependency(Dependency dependency)
final void	addTemplate(String template)
final BlocklyToCode	append(Object data)
boolean	checkIfDepProviderInputsProvide(Dependency dependency)
final void	clearCodeGeneratorBuffer()
void	clearSections()
static String	directProcessOutputBlock(BlocklyToCode master, Element element)
String	directProcessOutputBlockWithoutParentheses(Element element)	Helper method to get the code of an output block and remove surrounding parentheses if possible
static String	directProcessStatementBlock(BlocklyToCode master, Element element)
int	getBlockCount()	Returns the count of blocks currently processed from the block arrangement.
final List<BlocklyCompileNote>	getCompileNotes()
final List<Dependency>	getDependencies()
BlocklyEditorType	getEditorType()
final String	getExtraTemplatesCode()
final String	getGeneratedCode()
String	getHeadSection()
ModElement	getParent()
List<StatementInput>	getStatementInputsMatching(Predicate<StatementInput> predicate)
String	getTailSection()
final TemplateGenerator	getTemplateGenerator()
Collection<String>	getUsedBlocks()	This method returns collection of machine names of all blocks that are present in the provided Blockly arrangement
final Workspace	getWorkspace()
final void	popDepProviderInputStack()
final void	processBlockProcedure(List<Element> blocks)
final void	processOutputBlock(Element condition)
final void	processOutputBlockToInt(Element element)	Helper method to process an output block and cast to int when needed
final void	processOutputBlockWithoutParentheses(Element element)	Helper method to process an output block and remove surrounding parentheses if possible
final void	processOutputBlockWithoutParentheses(Element element, String blacklist)	Helper method to process an output block and remove surrounding parentheses if possible
final void	pushDepProviderInputStack(DependencyProviderInput statementInput)
void	setHeadSection(String headSection)
void	setTailSection(String tailSection)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.mcreator.generator.IGeneratorProvider

getGenerator, getGeneratorConfiguration, getGeneratorStats

Methods inherited from interface net.mcreator.workspace.IWorkspaceProvider

getFileManager, getFolderManager, getModElementManager, getWorkspaceFolder, getWorkspaceSettings, getWorkspaceUserSettings

Field Details

blockGenerators

protected final List<IBlockGenerator> blockGenerators

editorType

protected final BlocklyEditorType editorType

lastProceduralBlockType

protected String lastProceduralBlockType

Constructor Details

BlocklyToCode

public BlocklyToCode(Workspace workspace,
 ModElement parent,
 BlocklyEditorType editorType,
 @Nullable
 TemplateGenerator templateGenerator,
 IBlockGenerator... externalGenerators)

Parameters:

workspace -

The Workspace executing the code

editorType -

Blockly editor type

templateGenerator -

The folder location in each Generator containing the code template files

externalGenerators -

Define which block types (procedural and/or output) are supported inside this Blockly editor

Method Details

getGeneratedCode

public final String getGeneratedCode()

getExtraTemplatesCode

public final String getExtraTemplatesCode()
                                   throws TemplateGeneratorException

Throws:

TemplateGeneratorException

getCompileNotes

public final List<BlocklyCompileNote> getCompileNotes()

getParent

public ModElement getParent()

getEditorType

public BlocklyEditorType getEditorType()

getDependencies

public final List<Dependency> getDependencies()

append

public final BlocklyToCode append(Object data)

clearCodeGeneratorBuffer

public final void clearCodeGeneratorBuffer()

addCompileNote

public final void addCompileNote(BlocklyCompileNote compileNote)

addDependency

public final void addDependency(Dependency dependency)

getTemplateGenerator

@Nullable
public final TemplateGenerator getTemplateGenerator()

getWorkspace

@Nonnull
public final Workspace getWorkspace()

Specified by:

getWorkspace in interface IWorkspaceProvider

pushDepProviderInputStack

public final void pushDepProviderInputStack(DependencyProviderInput statementInput)

popDepProviderInputStack

public final void popDepProviderInputStack()

checkIfDepProviderInputsProvide

public boolean checkIfDepProviderInputsProvide(Dependency dependency)

getStatementInputsMatching

public List<StatementInput> getStatementInputsMatching(Predicate<StatementInput> predicate)

addTemplate

public final void addTemplate(String template)

processBlockProcedure

public final void processBlockProcedure(List<Element> blocks)
                                 throws TemplateGeneratorException

Throws:

TemplateGeneratorException

processOutputBlock

public final void processOutputBlock(Element condition)
                              throws TemplateGeneratorException

Throws:

TemplateGeneratorException

directProcessOutputBlock

public static String directProcessOutputBlock(BlocklyToCode master,
 Element element)
                                       throws TemplateGeneratorException

Throws:

TemplateGeneratorException

directProcessStatementBlock

public static String directProcessStatementBlock(BlocklyToCode master,
 Element element)
                                          throws TemplateGeneratorException

Throws:

TemplateGeneratorException

processOutputBlockWithoutParentheses

public final void processOutputBlockWithoutParentheses(Element element)
                                                throws TemplateGeneratorException

Helper method to process an output block and remove surrounding parentheses if possible

Parameters:

element - The element to process

Throws:

TemplateGeneratorException - If the template can't be generated

processOutputBlockWithoutParentheses

public final void processOutputBlockWithoutParentheses(Element element,
 String blacklist)
                                                throws TemplateGeneratorException

Helper method to process an output block and remove surrounding parentheses if possible

Parameters:

element - The element to process

blacklist - The characters that can't be contained at the top nesting level when optimizing the element

Throws:

TemplateGeneratorException - If the template can't be generated

directProcessOutputBlockWithoutParentheses

public String directProcessOutputBlockWithoutParentheses(Element element)
                                                  throws TemplateGeneratorException

Helper method to get the code of an output block and remove surrounding parentheses if possible

Parameters:

element - The element to process

Returns:

The generated code of the element with parentheses optimization

Throws:

TemplateGeneratorException - If the template can't be generated

processOutputBlockToInt

public final void processOutputBlockToInt(Element element)
                                   throws TemplateGeneratorException

Helper method to process an output block and cast to int when needed

Parameters:

element - The element to process

Throws:

TemplateGeneratorException - If the template can't be generated

getUsedBlocks

public Collection<String> getUsedBlocks()

This method returns collection of machine names of all blocks that are present in the provided Blockly arrangement

Returns:

Unmodifiable collection of machine names of all blocks that are present in the provided Blockly arrangement

setHeadSection

public void setHeadSection(String headSection)

setTailSection

public void setTailSection(String tailSection)

clearSections

public void clearSections()

getHeadSection

public String getHeadSection()

getTailSection

public String getTailSection()

getBlockCount

public int getBlockCount()

Returns the count of blocks currently processed from the block arrangement.

Returns:

The total number of blocks.