Package com.tameif.tame

Class TAMELogic

java.lang.Object

com.tameif.tame.TAMELogic

All Implemented Interfaces:

TAMEConstants

public final class TAMELogic
extends java.lang.Object
implements TAMEConstants

Rules class. Governs most if not all logic in TAME.

Author:

Matthew Tropiano

Field Summary

Fields inherited from interface com.tameif.tame.TAMEConstants

CUE_ERROR, CUE_FATAL, CUE_PAUSE, CUE_QUIT, CUE_TEXT, CUE_TEXTF, CUE_TRACE, CUE_WAIT, DEFAULT_FUNCTION_DEPTH, DEFAULT_RUNAWAY_THRESHOLD, HEADER_AUTHOR, HEADER_COUNTRY, HEADER_EMAIL, HEADER_LANGUAGE, HEADER_TAME_FUNCDEPTH_MAX, HEADER_TAME_RUNAWAY_MAX, HEADER_TITLE, HEADER_TWITTER, HEADER_VERSION, HEADER_WEBSITE, IDENTITY_ARCHETYPE_CONTAINER, IDENTITY_CURRENT_PLAYER, IDENTITY_CURRENT_ROOM, IDENTITY_CURRENT_WORLD, RETURN_VARIABLE

Constructor Summary

Constructors

Constructor and Description
TAMELogic()

Method Summary

Modifier and Type	Method and Description
static void	callBlock(TAMERequest request, TAMEResponse response, TElementContext<?> context, Block block) Performs the necessary tasks for calling an object block.
static void	callBlock(TAMERequest request, TAMEResponse response, TElementContext<?> context, Block block, boolean functionBlock, ValueSet blockLocal) Performs the necessary tasks for calling an object block.
static boolean	callElementBlock(TAMERequest request, TAMEResponse response, TElementContext<?> context, BlockEntry blockEntry) Attempts to resolve and call an element block.
static boolean	callElementBlock(TAMERequest request, TAMEResponse response, TElementContext<?> context, BlockEntry blockEntry, java.lang.String openTarget, java.lang.Iterable<java.lang.String> locals) Attempts to resolve and call an element block.
static Value	callElementFunction(TAMERequest request, TAMEResponse response, java.lang.String functionName, TElementContext<?> originContext) Calls a function from an arbitrary context, using the bound element as a lineage search point.
static boolean	checkObjectAccessibility(TAMERequest request, TAMEResponse response, TPlayer player, TObject object) Checks if an object is accessible to a player.
static void	doArithmeticStackFunction(TAMERequest request, TAMEResponse response, int functionType) Performs an arithmetic function on the stack.
static void	doBrowse(TAMERequest request, TAMEResponse response, ObjectContainer element) Attempts to perform an element browse.
static void	doBrowse(TAMERequest request, TAMEResponse response, ObjectContainer element, java.lang.String tag) Attempts to perform an element browse.
static void	doPlayerSwitch(TAMERequest request, TAMEResponse response, TPlayer nextPlayer) Attempts to perform a player switch.
static void	doRoomPop(TAMERequest request, TAMEResponse response, TPlayer player) Attempts to perform a room stack pop for a player.
static void	doRoomPush(TAMERequest request, TAMEResponse response, TPlayer player, TRoom nextRoom) Attempts to perform a room stack push for a player.
static void	doRoomSwitch(TAMERequest request, TAMEResponse response, TPlayer player, TRoom nextRoom) Attempts to perform a room switch.
static boolean	enqueueInterpretedAction(TAMERequest request, TAMEResponse response, com.tameif.tame.TAMELogic.InterpreterContext interpreterContext) Enqueues an action based on how it is interpreted.
static java.lang.String	getVersion() Gets the embedded version string.
static TAMEResponse	handleCommand(TAMEModuleContext moduleContext, TAMECommand command, boolean tracing) Handles a single action.
static TAMEResponse	handleInit(TAMEModuleContext moduleContext, boolean tracing) Handles context initialization, returning the response from it.
static TAMEResponse	handleInit(TAMEModuleContext moduleContext, TraceType... traceTypes) Handles context initialization, returning the response from it.
static TAMEResponse	handleRequest(TAMEModuleContext moduleContext, java.lang.String input, boolean tracing) Handles a full request.
static TAMEResponse	handleRequest(TAMEModuleContext moduleContext, java.lang.String input, TraceType... traceTypes) Handles a full request.
static void	processCommand(TAMERequest request, TAMEResponse response, TAMECommand command) Processes a single action.
static java.lang.String[]	tokenizeInput(TAMEModuleContext moduleContext, java.lang.String inputMessage) Tokenizes the input string into tokens based on module settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

TAMELogic

public TAMELogic()

Method Detail

getVersion

public static java.lang.String getVersion()

Gets the embedded version string.

Returns:

the version string or "SNAPSHOT"

handleInit

public static TAMEResponse handleInit(TAMEModuleContext moduleContext,
                                      boolean tracing)

Handles context initialization, returning the response from it. This method must be called for newly-created contexts NOT LOADED FROM A PERSISTED CONTEXT STATE.

Parameters:

moduleContext - the module context.

tracing - if true, this does full tracing.

Returns:

a TAMERequest a new request.

handleInit

public static TAMEResponse handleInit(TAMEModuleContext moduleContext,
                                      TraceType... traceTypes)

Handles context initialization, returning the response from it. This method must be called for newly-created contexts NOT LOADED FROM A PERSISTED CONTEXT STATE.

Parameters:

moduleContext - the module context.

traceTypes - output trace cues for each request.

Returns:

a TAMERequest a new request.

handleRequest

public static TAMEResponse handleRequest(TAMEModuleContext moduleContext,
                                         java.lang.String input,
                                         boolean tracing)

Handles a full request.

Parameters:

moduleContext - the module context.

input - the client input query.

tracing - if true, this does full tracing.

Returns:

a TAMERequest a new request.

handleRequest

public static TAMEResponse handleRequest(TAMEModuleContext moduleContext,
                                         java.lang.String input,
                                         TraceType... traceTypes)

Handles a full request.

Parameters:

moduleContext - the module context.

input - the client input query.

traceTypes - output trace cues for each request.

Returns:

a TAMERequest a new request.

handleCommand

public static TAMEResponse handleCommand(TAMEModuleContext moduleContext,
                                         TAMECommand command,
                                         boolean tracing)

Handles a single action. Counts as a "successful command."

Parameters:

moduleContext - the module context.

command - the command to enqueue.

tracing - if true, this does tracing.

Returns:

a TAMERequest a new request.

processCommand

public static void processCommand(TAMERequest request,
                                  TAMEResponse response,
                                  TAMECommand command)
                           throws TAMEInterrupt

Processes a single action.

Parameters:

request - the request object.

response - the response object.

command - the action to process.

Throws:

TAMEInterrupt - if an uncaught interrupt occurs.

TAMEFatalException - if something goes wrong during execution.

tokenizeInput

public static java.lang.String[] tokenizeInput(TAMEModuleContext moduleContext,
                                               java.lang.String inputMessage)

Tokenizes the input string into tokens based on module settings.

Parameters:

moduleContext - the module context to use (for object availability).

inputMessage - the input message to tokenize.

Returns:

the tokens to parse.

enqueueInterpretedAction

public static boolean enqueueInterpretedAction(TAMERequest request,
                                               TAMEResponse response,
                                               com.tameif.tame.TAMELogic.InterpreterContext interpreterContext)
                                        throws TAMEInterrupt

Enqueues an action based on how it is interpreted.

Parameters:

request - the request object.

response - the response object.

interpreterContext - the interpreter context (left after interpretation).

Returns:

true if interpret was good and an action was enqueued, false if error.

Throws:

TAMEInterrupt - if an uncaught interrupt occurs.

TAMEFatalException - if something goes wrong during execution.

callBlock

public static void callBlock(TAMERequest request,
                             TAMEResponse response,
                             TElementContext<?> context,
                             Block block)
                      throws TAMEInterrupt

Performs the necessary tasks for calling an object block. Ensures that the block is called cleanly.

Parameters:

request - the request object.

response - the response object.

context - the context that the block is executed through.

block - the block to execute.

Throws:

TAMEInterrupt - if an interrupt occurs.

callBlock

public static void callBlock(TAMERequest request,
                             TAMEResponse response,
                             TElementContext<?> context,
                             Block block,
                             boolean functionBlock,
                             ValueSet blockLocal)
                      throws TAMEInterrupt

Performs the necessary tasks for calling an object block. Ensures that the block is called cleanly.

Parameters:

request - the request object.

response - the response object.

context - the context that the block is executed through.

block - the block to execute.

functionBlock - if true, this is a function call (which is slightly different).

blockLocal - the local value hash to use on invoke.

Throws:

TAMEInterrupt - if an interrupt occurs.

callElementBlock

public static boolean callElementBlock(TAMERequest request,
                                       TAMEResponse response,
                                       TElementContext<?> context,
                                       BlockEntry blockEntry)
                                throws TAMEInterrupt

Attempts to resolve and call an element block.

Parameters:

request - the request.

response - the response.

context - the element context.

blockEntry - the block entry to resolve.

Returns:

true if called, false if not.

Throws:

TAMEInterrupt - if an interrupt occurs.

callElementBlock

public static boolean callElementBlock(TAMERequest request,
                                       TAMEResponse response,
                                       TElementContext<?> context,
                                       BlockEntry blockEntry,
                                       java.lang.String openTarget,
                                       java.lang.Iterable<java.lang.String> locals)
                                throws TAMEInterrupt

Attempts to resolve and call an element block.

Parameters:

request - the request.

response - the response.

context - the element context.

blockEntry - the block entry to resolve.

openTarget - the value of the open action.

locals - the extra strings for the open action (only the first one is used).

Returns:

true if called, false if not.

Throws:

TAMEInterrupt - if an interrupt occurs.

callElementFunction

public static Value callElementFunction(TAMERequest request,
                                        TAMEResponse response,
                                        java.lang.String functionName,
                                        TElementContext<?> originContext)
                                 throws TAMEInterrupt

Calls a function from an arbitrary context, using the bound element as a lineage search point.

Parameters:

request - the request object.

response - the response object.

functionName - the function to execute.

originContext - the origin context (and then element).

Returns:

the return value from the function call. if no return, returns false.

Throws:

ModuleException - if the function does not exist in the lineage of the target element.

TAMEInterrupt - if an interrupt occurs.

checkObjectAccessibility

public static boolean checkObjectAccessibility(TAMERequest request,
                                               TAMEResponse response,
                                               TPlayer player,
                                               TObject object)

Checks if an object is accessible to a player.

Parameters:

request - the request object.

response - the response object.

player - the player viewpoint.

object - the object to check.

Returns:

true if the object is considered "accessible," false if not.

doArithmeticStackFunction

public static void doArithmeticStackFunction(TAMERequest request,
                                             TAMEResponse response,
                                             int functionType)

Performs an arithmetic function on the stack.

Parameters:

request - the request context.

response - the response object.

functionType - the function type.

Throws:

ModuleExecutionException - if functionType is less than 0 or greater than or equal to ArithmeticOperator.VALUES.length.

doPlayerSwitch

public static void doPlayerSwitch(TAMERequest request,
                                  TAMEResponse response,
                                  TPlayer nextPlayer)
                           throws TAMEInterrupt

Attempts to perform a player switch.

Parameters:

request - the request object.

response - the response object.

nextPlayer - the next player.

Throws:

TAMEInterrupt - if an interrupt occurs.

doRoomPop

public static void doRoomPop(TAMERequest request,
                             TAMEResponse response,
                             TPlayer player)
                      throws TAMEInterrupt

Attempts to perform a room stack pop for a player.

Parameters:

request - the request object.

response - the response object.

player - the player to pop a room context from.

Throws:

TAMEInterrupt - if an interrupt occurs.

doRoomPush

public static void doRoomPush(TAMERequest request,
                              TAMEResponse response,
                              TPlayer player,
                              TRoom nextRoom)
                       throws TAMEInterrupt

Attempts to perform a room stack push for a player.

Parameters:

request - the request object.

response - the response object.

player - the player to push a room context onto.

nextRoom - the room to push.

Throws:

TAMEInterrupt - if an interrupt occurs.

doRoomSwitch

public static void doRoomSwitch(TAMERequest request,
                                TAMEResponse response,
                                TPlayer player,
                                TRoom nextRoom)
                         throws TAMEInterrupt

Attempts to perform a room switch.

Parameters:

request - the request object.

response - the response object.

player - the player that is switching rooms.

nextRoom - the target room.

Throws:

TAMEInterrupt - if an interrupt occurs.

doBrowse

public static void doBrowse(TAMERequest request,
                            TAMEResponse response,
                            ObjectContainer element)
                     throws TAMEInterrupt

Attempts to perform an element browse.

Parameters:

request - the request object.

response - the response object.

element - the element to browse.

Throws:

TAMEInterrupt - if an interrupt occurs.

doBrowse

public static void doBrowse(TAMERequest request,
                            TAMEResponse response,
                            ObjectContainer element,
                            java.lang.String tag)
                     throws TAMEInterrupt

Attempts to perform an element browse.

Parameters:

request - the request object.

response - the response object.

element - the element to browse.

tag - the tag name to search for, if any (null for no tag filter).

Throws:

TAMEInterrupt - if an interrupt occurs.