Module com.wyu4.snowberryjam

Package com.wyu4.snowberryjam.compiler

Class Compiler

java.lang.Object

com.wyu4.snowberryjam.compiler.LocalStorage

com.wyu4.snowberryjam.compiler.Compiler

public abstract class Compiler
extends LocalStorage

The Snowberry Jam compiler class

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<BiConsumer<String,String>>	ERROR_LISTENERS
private static final org.slf4j.Logger	logger
private static final List<BiConsumer<String,String>>	PRINT_LISTENERS
private static final List<BiConsumer<String,String>>	WARN_LISTENERS

Constructor Summary

Constructors

Constructor	Description
Compiler()

Method Summary

Modifier and Type	Method	Description
static void	addErrorListener(BiConsumer<String,String> consumer)	Add a error listener
static void	addPrintListener(BiConsumer<String,String> consumer)	Add a print listener
static void	addWarnListener(BiConsumer<String,String> consumer)	Add a warn listener
static Object	asPrimitiveObject(com.fasterxml.jackson.databind.JsonNode node)	Get a node as a primitive object
static void	compile(String source)	Compile the JSON contents of a String.
static void	compileBody(com.fasterxml.jackson.databind.JsonNode body, BodyStack stack)	Converts the contents of any "body":[] property into tasks, and stores them in a BodyStack.
private static void	compileEvents(com.fasterxml.jackson.databind.JsonNode projectBody)	Compiles and stores all the events found in the "events":[] section in the project body to stacks, and subsequently converts compiles bodies to stacks.
static void	error(Object error)	Send an error statement to the development console.
static void	error(Object error, Exception e)	Send an error statement and stack trace to the development console.
static String	formatString(String str)
static String	getId(com.fasterxml.jackson.databind.JsonNode node)	Grabs the ID of the node
static String	getName(com.fasterxml.jackson.databind.JsonNode node)	Grabs the name of the node
private static String	getProperty(com.fasterxml.jackson.databind.JsonNode node, String key)	Grabs the value of a property given the key.
private static com.fasterxml.jackson.databind.JsonNode	getTree(String source)	Creates a JsonNode tree from a JSON String
private static void	mapProjectData(com.fasterxml.jackson.databind.JsonNode tree)	Map the project data.
private static void	mapProjectVariables(com.fasterxml.jackson.databind.JsonNode projectBody)	Maps/stores all the variables found in the project's body.
static void	print(Object message, Object... args)	Send a print statement to the development console.
static void	printTab(Object message, Object... args)	Send a print statement to the development console.
static void	warn(Object message, Object... args)	Send a warning statement to the development console.

Methods inherited from class com.wyu4.snowberryjam.compiler.LocalStorage

addCachedValue, addInputSubscription, addVariableListener, copyStack, createThread, createVariable, flush, formatMessage, getDefaultSource, getPointer, getRaw, getVariableNames, increasePointer, isRunning, runStack, sendInput, setDescription, setName, setVariable, stackAdd, stopRun

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

PRINT_LISTENERS

private static final List<BiConsumer<String,String>> PRINT_LISTENERS

WARN_LISTENERS

private static final List<BiConsumer<String,String>> WARN_LISTENERS

ERROR_LISTENERS

private static final List<BiConsumer<String,String>> ERROR_LISTENERS

Constructor Details

Compiler

public Compiler()

Method Details

formatString

public static String formatString(String str)

getTree

private static com.fasterxml.jackson.databind.JsonNode getTree(String source)
                                                        throws com.fasterxml.jackson.core.JsonProcessingException

Creates a JsonNode tree from a JSON String

Parameters:

source - JSON source code as a string

Returns:

A JsonNode representation of the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - Any exceptions that arise while mapping the contents of the string

See Also:

• compile(String)

compile

public static void compile(String source)
                    throws com.fasterxml.jackson.databind.JsonMappingException,
com.fasterxml.jackson.core.JsonProcessingException

Compile the JSON contents of a String. Starts by creating a tree, maps project data, maps variables, and then compiles events.

Parameters:

source - JSON source code as a string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - Any exceptions that arise while mapping the contents of the string

com.fasterxml.jackson.databind.JsonMappingException

See Also:

• getTree(String)
• mapProjectData(JsonNode)
• mapProjectVariables(JsonNode)
• compileEvents(JsonNode)

mapProjectData

private static void mapProjectData(com.fasterxml.jackson.databind.JsonNode tree)

Map the project data. THis includes any metadata such as the project name and description.

Parameters:

tree - The full project tree

mapProjectVariables

private static void mapProjectVariables(com.fasterxml.jackson.databind.JsonNode projectBody)

Maps/stores all the variables found in the project's body. This only includes variable initialization in the "variables":[] section. This uses protected methods in LocalStorage

Parameters:

projectBody - The body of the project

See Also:

• LocalStorage.createVariable(String, Object)

compileEvents

private static void compileEvents(com.fasterxml.jackson.databind.JsonNode projectBody)

Compiles and stores all the events found in the "events":[] section in the project body to stacks, and subsequently converts compiles bodies to stacks. This uses protected methods in LocalStorage

Parameters:

projectBody - The body of the project

See Also:

• LocalStorage.stackAdd(ExecutableTask)
• compileBody(JsonNode, BodyStack)

compileBody

public static void compileBody(com.fasterxml.jackson.databind.JsonNode body,
 BodyStack stack)

Converts the contents of any "body":[] property into tasks, and stores them in a BodyStack.

Parameters:

body - The selected body to compile

stack - The stack to store compile tasks

See Also:

• BodyStack
• ExecutableTask

getProperty

private static String getProperty(com.fasterxml.jackson.databind.JsonNode node,
 String key)

Grabs the value of a property given the key. Used by more specific methods.

Parameters:

node - A node

key - The key

Returns:

The value of the property as a string. May be null if the property isn't found.

See Also:

• getId(JsonNode)
• getName(JsonNode)

getId

public static String getId(com.fasterxml.jackson.databind.JsonNode node)

Grabs the ID of the node

Parameters:

node - A node

Returns:

The ID as a string. User helper methods to convert this into its respective Enum. May be null if the ID isn't found.

See Also:

• EnumHelper.stringToId(String)

getName

public static String getName(com.fasterxml.jackson.databind.JsonNode node)

Grabs the name of the node

Parameters:

node - A node

Returns:

The name as a string. May be null if the name isn't found.

asPrimitiveObject

public static Object asPrimitiveObject(com.fasterxml.jackson.databind.JsonNode node)

Get a node as a primitive object

Parameters:

node - A node

Returns:

A Double, String, Boolean, or Array parsed as an Object. Might return null if the node isn't primitive.

print

public static void print(Object message,
 Object... args)

Send a print statement to the development console.

Parameters:

message - Message to send (arguments can be inserted by adding "{}" in the message).

args - Arguments to append in the message

See Also:

• printTab(Object, Object...)
• error(Object)
• error(Object, Exception)
• warn(Object, Object...)

printTab

public static void printTab(Object message,
 Object... args)

Send a print statement to the development console. Messages send using this are inlined.

Parameters:

message - Message to send (arguments can be inserted by adding "{}" in the message).

args - Arguments to append in the message

See Also:

• print(Object, Object...)
• error(Object)
• error(Object, Exception)
• warn(Object, Object...)

error

public static void error(Object error)

Send an error statement to the development console.

Parameters:

error - Message to send (arguments can be inserted by adding "{}" in the message).

See Also:

• print(Object, Object...)
• printTab(Object, Object...)
• error(Object, Exception)
• warn(Object, Object...)

error

public static void error(Object error,
 Exception e)

Send an error statement and stack trace to the development console.

Parameters:

error - Error to send

e - Exception to send (used to print stack trace)

See Also:

• print(Object, Object...)
• printTab(Object, Object...)
• error(Object)
• warn(Object, Object...)

warn

public static void warn(Object message,
 Object... args)

Send a warning statement to the development console.

Parameters:

message - Warning to send (arguments can be inserted by adding "{}" in the message).

args - Arguments to append in the message

See Also:

• print(Object, Object...)
• printTab(Object, Object...)
• error(Object)
• error(Object, Exception)

addPrintListener

public static void addPrintListener(BiConsumer<String,String> consumer)

Add a print listener

Parameters:

consumer - Consumer to run when something is printed

See Also:

• print(Object, Object...)

addWarnListener

public static void addWarnListener(BiConsumer<String,String> consumer)

Add a warn listener

Parameters:

consumer - Consumer to run when something is warned

See Also:

• warn(Object, Object...)

addErrorListener

public static void addErrorListener(BiConsumer<String,String> consumer)

Add a error listener

Parameters:

consumer - Consumer to run when something is errored

See Also:

• warn(Object, Object...)