com.threecrickets.scripturian.adapter

Class ClojureAdapter

java.lang.Object

com.threecrickets.scripturian.adapter.LanguageAdapterBase

com.threecrickets.scripturian.adapter.ClojureAdapter

All Implemented Interfaces:

LanguageAdapter

public class ClojureAdapter
extends LanguageAdapterBase

A LanguageAdapter that supports the Clojure language.

Note: Clojure adapters in all LanguageManager will share the same runtime instance of Clojure, which is a JVM-wide singleton.

This is important! Even though every execution context gets its own Clojure namespace, all namespaces exist in the same runtime. If one execution context loads code into a namespace, all execution contexts will be able to access it. This means that two contexts cannot use different versions of a library at the same time if the versions have the same namespace.

Note that Program.prepare() does not actually compile the source code, but it does parse it, making it quicker to execute later.

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
protected static clojure.lang.Var	ALLOW_UNRESOLVED_VARS clojure.core/*allow-unresolved-vars*
protected static clojure.lang.Symbol	CLOJURE_CORE clojure.core
static String	CLOJURE_NAMESPACE Namespace attribute.
protected static clojure.lang.Var	IN_NS (in-ns)
static String	NAMESPACE_PREFIX Prefix prepended to all namespace names created by this adapter.
protected static clojure.lang.Var	REFER (clojure.core/refer)

Fields inherited from interface com.threecrickets.scripturian.LanguageAdapter

DEFAULT_EXTENSION, DEFAULT_TAG, EXTENSIONS, LANGUAGE_NAME, LANGUAGE_VERSION, NAME, TAGS, VERSION

Constructor Summary

Constructors

Constructor and Description
ClojureAdapter() Constructor.

Method Summary

Modifier and Type	Method and Description
static ExecutionException	createExecutionException(int startLineNumber, clojure.lang.Compiler.CompilerException x) Creates an execution exception with a full stack.
Program	createProgram(String sourceCode, boolean isScriptlet, int position, int startLineNumber, int startColumnNumber, Executable executable) Turns source code into a program.
Object	enter(String entryPointName, Executable executable, ExecutionContext executionContext, Object... arguments) Enters the executable at a stored, named location.
static String	extractExceptionStackFromMessage(String message, Collection<StackFrame> stack) Annoyingly, Clojure's CompilerException accepts stack information (Compiler.SOURCE, Compiler.LINE) in its constructor, but does not store it directly.
static clojure.lang.Namespace	getClojureNamespace(ExecutionContext executionContext) Gets a Clojure namespace stored in the execution context, creating it if it doesn't exist.
String	getSourceCodeForExpressionInclude(String expression, Executable executable) Creates source code for including the output of a text-with-scriptlets document.
String	getSourceCodeForExpressionOutput(String expression, Executable executable) Creates source code for outputting a source code expression to standard output.
String	getSourceCodeForLiteralOutput(String literal, Executable executable) Creates source code for outputting literal text to standard output.
void	releaseContext(ExecutionContext executionContext) Cleans up any resources used for an execution context.
static String	toClojureStyle(String camelCase) From somethingLikeThis to something-like-this.

Methods inherited from class com.threecrickets.scripturian.adapter.LanguageAdapterBase

getAttributes, getLock, getManager, isEphemeral, isThreadSafe, setManager

Methods inherited from class java.lang.Object

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

Field Detail

CLOJURE_NAMESPACE

public static final String CLOJURE_NAMESPACE

Namespace attribute.

NAMESPACE_PREFIX

public static final String NAMESPACE_PREFIX

Prefix prepended to all namespace names created by this adapter.

See Also:

Constant Field Values

CLOJURE_CORE

protected static final clojure.lang.Symbol CLOJURE_CORE

clojure.core

IN_NS

protected static final clojure.lang.Var IN_NS

(in-ns)

ALLOW_UNRESOLVED_VARS

protected static final clojure.lang.Var ALLOW_UNRESOLVED_VARS

clojure.core/*allow-unresolved-vars*

REFER

protected static final clojure.lang.Var REFER

(clojure.core/refer)

Constructor Detail

ClojureAdapter

public ClojureAdapter()
               throws LanguageAdapterException

Constructor.

Throws:

LanguageAdapterException - In case of an initialization error

Method Detail

createExecutionException

public static ExecutionException createExecutionException(int startLineNumber,
                                                          clojure.lang.Compiler.CompilerException x)

Creates an execution exception with a full stack.

Parameters:

startLineNumber - The line number in the document for where the program's source code begins

x - The Clojure compiler exception

Returns:

The execution exception

extractExceptionStackFromMessage

public static String extractExceptionStackFromMessage(String message,
                                                      Collection<StackFrame> stack)

Annoyingly, Clojure's CompilerException accepts stack information (Compiler.SOURCE, Compiler.LINE) in its constructor, but does not store it directly. This information is indirectly available to us in the error message. We'll just have to parse this error message to get our valuable data!

Parameters:

message - The exception message

stack - The stack

Returns:

New exception message

getClojureNamespace

public static clojure.lang.Namespace getClojureNamespace(ExecutionContext executionContext)

Gets a Clojure namespace stored in the execution context, creating it if it doesn't exist. Each execution context is guaranteed to have its own namespace.

Parameters:

executionContext - The execution context

Returns:

The Clojure namespace

toClojureStyle

public static String toClojureStyle(String camelCase)

From somethingLikeThis to something-like-this.

Parameters:

camelCase - somethingLikeThis

Returns:

something-like-this

getSourceCodeForLiteralOutput

public String getSourceCodeForLiteralOutput(String literal,
                                            Executable executable)
                                     throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting literal text to standard output.

Specified by:

getSourceCodeForLiteralOutput in interface LanguageAdapter

Overrides:

getSourceCodeForLiteralOutput in class LanguageAdapterBase

Parameters:

literal - The literal text

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionOutput

public String getSourceCodeForExpressionOutput(String expression,
                                               Executable executable)
                                        throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for outputting a source code expression to standard output.

Specified by:

getSourceCodeForExpressionOutput in interface LanguageAdapter

Overrides:

getSourceCodeForExpressionOutput in class LanguageAdapterBase

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

getSourceCodeForExpressionInclude

public String getSourceCodeForExpressionInclude(String expression,
                                                Executable executable)
                                         throws ParsingException

Description copied from interface: LanguageAdapter

Creates source code for including the output of a text-with-scriptlets document.

For this to work, the executable must have been created with a container that supports an inclusion command named according to the language manager attribute LanguageManager.CONTAINER_INCLUDE_COMMAND_ATTRIBUTE.

Specified by:

getSourceCodeForExpressionInclude in interface LanguageAdapter

Overrides:

getSourceCodeForExpressionInclude in class LanguageAdapterBase

Parameters:

expression - The source code expression

executable - The executable

Returns:

Source code

Throws:

ParsingException - In case of a parsing error

See Also:

LanguageManager.getAttributes()

createProgram

public Program createProgram(String sourceCode,
                             boolean isScriptlet,
                             int position,
                             int startLineNumber,
                             int startColumnNumber,
                             Executable executable)
                      throws ParsingException

Description copied from interface: LanguageAdapter

Turns source code into a program. The intent is for the implementation to perform the bare minimum required for detecting errors in the source code. For better initialization, likely at the cost of extra processing up front, call Program.prepare() on the program.

Parameters:

sourceCode - The source code

isScriptlet - Whether the source code is a scriptlet

position - The program's position in the executable

startLineNumber - The line number in the document for where the program's source code begins

startColumnNumber - The column number in the document for where the program's source code begins

executable - The executable

Returns:

A program

Throws:

ParsingException - In case of a parsing error

enter

public Object enter(String entryPointName,
                    Executable executable,
                    ExecutionContext executionContext,
                    Object... arguments)
             throws NoSuchMethodException,
                    ParsingException,
                    ExecutionException

Description copied from interface: LanguageAdapter

Enters the executable at a stored, named location. According to the language, the entry point can be a function, method, lambda, closure, etc.

Specified by:

enter in interface LanguageAdapter

Overrides:

enter in class LanguageAdapterBase

Parameters:

entryPointName - The entry point name

executable - The executable

executionContext - The executable context

arguments - Optional state to pass to the entry point

Returns:

State returned from to the entry point or null

Throws:

NoSuchMethodException - In case the entry point does not exist

ParsingException - In case of a parsing error

ExecutionException - In case of an execution error

releaseContext

public void releaseContext(ExecutionContext executionContext)

Description copied from interface: LanguageAdapter

Cleans up any resources used for an execution context.

Specified by:

releaseContext in interface LanguageAdapter

Overrides:

releaseContext in class LanguageAdapterBase

Parameters:

executionContext - The execution context

See Also:

ExecutionContext.getAttributes()