gnu.expr

Class Language

java.lang.Object

gnu.expr.Language

Direct Known Subclasses:

LispLanguage, XQuery

public abstract class Language
extends java.lang.Object

Contains various language-dependent methods. Also contains "global" state about the executation environment, such as the global Environment. There can be multiple Languages associated with different threads, representing mutiple top-levels. (However, this functionality is incomplete.)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.InheritableThreadLocal<Language>	current
protected Environment	environ The environment for language built-ins and predefined bindings.
static int	FUNCTION_NAMESPACE
protected static Language	global
static int	NAMESPACE_PREFIX_NAMESPACE
static int	PARSE_CURRENT_NAMES Flag to tell parse to use current NameLookup.
static int	PARSE_EMIT_MAIN
static int	PARSE_EXPLICIT Compilation explicitly requested, not just because of an import.
static int	PARSE_FOR_APPLET
static int	PARSE_FOR_EVAL
static int	PARSE_FOR_LINT
static int	PARSE_FOR_SERVLET
static int	PARSE_IMMEDIATE Flag to tell parse that expression will be evaluated immediately.
static int	PARSE_INTERACTIVE_MODULE
static int	PARSE_ONE_LINE Flag to tell parse to only read a single line if possible.
static int	PARSE_PROLOG Flag to tell parser to continue until we have the module name.
static boolean	requirePedantic
protected Environment	userEnv If non-null, the user environment.
static int	VALUE_NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Language()

Method Summary

Modifier and Type	Method and Description
Type	asType(java.lang.Object spec) "Coerce" a language-specific "type specifier" object to a Type.
java.lang.Object	booleanObject(boolean b)
int	booleanValue(java.lang.Object value) Test if a value is considered "true" in this language.
java.lang.Object	coerceFromObject(java.lang.Class clas, java.lang.Object obj)
java.lang.Object	coerceToObject(java.lang.Class clas, java.lang.Object obj)
Declaration	declFromField(ModuleExp mod, java.lang.Object fvalue, Field fld)
Type	decodeType(Type javaType, java.lang.String annotType, ParameterizedType parameterizedType)
protected void	defAliasStFld(java.lang.String name, java.lang.String cname, java.lang.String fname) Declare in the current Environment a variable aliased to a static field.
void	define(java.lang.String sym, java.lang.Object p) Enter a value into the current environment.
void	defineFunction(Named proc) Enter a named function into the current environment.
void	defineFunction(java.lang.String name, java.lang.Object proc) Enter a function into the current environment.
protected void	defProcStFld(java.lang.String name, java.lang.String cname) Declare in the current Environment a procedure bound to a static field.
protected void	defProcStFld(java.lang.String name, java.lang.String cname, java.lang.String fname) Declare in the current Environment a procedure bound to a static field.
protected void	defProcStFld(Symbol sym, java.lang.String cname, java.lang.String fname)
protected void	defProcStFldAs(java.lang.String asName, java.lang.String cname, java.lang.String mname) Declare by name in the current environment a procedure bound to a static field.
static Language	detect(gnu.kawa.io.InPort port) Detect the programming language of a file based on its first line.
static Language	detect(java.io.InputStream in) Detect the programming language of a file based on its first line.
static Language	detect(java.lang.String line) Detect the programming language of a file based on its first line.
java.lang.String	encodeType(Type type) Encode this type as a parseable string.
java.lang.Object	eval(gnu.kawa.io.InPort port) Evaluate expression(s) read from an InPort.
void	eval(gnu.kawa.io.InPort port, CallContext ctx)
java.lang.Object	eval(java.io.Reader in) Evaluate expression(s) read from a Reader.
void	eval(java.io.Reader in, Consumer out) Read expressions from a Reader and write the result to a Consumer.
void	eval(java.io.Reader in, java.io.Writer out) Read expressions from a Reader and write the result to a Writer.
java.lang.Object	eval(java.lang.String string) Return the result of evaluating a string as a source expression.
void	eval(java.lang.String string, Consumer out) Evaluate a string and write the result value(s) to a Consumer.
void	eval(java.lang.String string, PrintConsumer out) Evaluate a string and write the result value(s) to a PrintConsumer.
void	eval(java.lang.String string, java.io.Writer out) Evaluate a string and write the result value(s) on a Writer.
java.lang.String	formatType(Type type)
Compilation	getCompilation(Lexer lexer, int options, ModuleInfo info)
Compilation	getCompilation(SourceMessages messages, NameLookup lexical)
java.lang.String	getCompilationClass()
static Language	getDefaultLanguage()
Environment	getEnvironment() Get current user environment.
java.lang.Object	getEnvPropertyFor(Declaration decl)
java.lang.Object	getEnvPropertyFor(java.lang.reflect.Field fld, java.lang.Object value)
java.util.List<java.lang.String>	getExtensions()
gnu.kawa.format.AbstractFormat	getFormat(boolean readable)
static Language	getInstance(java.lang.String name) Look for a language with the given name or extension.
static Language	getInstance(java.lang.String langName, java.lang.Class langClass)
static Language	getInstanceFromFilenameExtension(java.lang.String filename)
Environment	getLangEnvironment()
Type	getLangTypeFor(Type type)
static java.lang.String[][]	getLanguages() Get a list of all available languages
abstract Lexer	getLexer(gnu.kawa.io.InPort inp, SourceMessages messages)
java.lang.String	getName()
Type	getNamedType(java.lang.String name) Get the corresponding Type for a given name.
int	getNamespaceOf(Declaration decl) Return the namespace (e.g value or function) of a Declaration.
Environment	getNewEnvironment()
Consumer	getOutputConsumer(java.io.Writer out)
java.lang.String	getPrimaryPrompt()
java.lang.String	getSecondaryPrompt()
Symbol	getSymbol(java.lang.String name)
Type	getTypeFor(java.lang.Class clas)
Type	getTypeFor(Expression exp)
Type	getTypeFor(Expression exp, boolean lenient) Interpreting exp as a type specifier, get the actual type.
Type	getTypeFor(java.lang.Object spec, boolean lenient) Convert a "type value" to a Type.
Type	getTypeFor(java.lang.String name)
boolean	hasNamespace(Declaration decl, int namespace) True if a Declaration is in the specified namespace.
boolean	hasSeparateFunctionNamespace() True if functions are in a separate name space from variable.
boolean	isTrue(java.lang.Object value) Test if a value is considered "true" in this language.
static boolean	isValidJavaName(java.lang.String name)
void	loadClass(java.lang.String name)
java.lang.Object	lookup(java.lang.String name)
NamedLocation	lookupBuiltin(Symbol name, java.lang.Object property, int hash)
static java.lang.String	mangleName(java.lang.String name, int kind) Convert a string to a safe Java identifier.
java.lang.Object	noValue() The value to return for a "void" result.
boolean	parse(Compilation tr)
abstract boolean	parse(Compilation comp, int options)
Compilation	parse(gnu.kawa.io.InPort port, SourceMessages messages, int options) Parse one or more expressions.
Compilation	parse(gnu.kawa.io.InPort port, SourceMessages messages, int options, ModuleInfo info)
Compilation	parse(Lexer lexer, int options, ModuleInfo info)
static void	registerLanguage(java.lang.String[] langMapping) Add a language to the list.
void	resolve(Compilation comp) Perform any need post-processing after we've read all the modules to be compiled.
static void	restoreCurrent(Language saved)
void	runAsApplication(java.lang.String[] args)
static void	setCurrentLanguage(Language language)
static void	setDefaults(Language lang)
static Language	setSaveCurrent(Language language)
static Type	unionType(Type t1, Type t2)

Methods inherited from class java.lang.Object

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

Field Detail

current

protected static final java.lang.InheritableThreadLocal<Language> current

global

protected static Language global

environ

protected Environment environ

The environment for language built-ins and predefined bindings.

userEnv

protected Environment userEnv

If non-null, the user environment. This allows "bunding" an Environment with a Language. This is partly to match existing documentation, and partly for convenience from Java code. Normally, userEnv is null, in which case the user environment is extracted from the current thread.

PARSE_IMMEDIATE

public static final int PARSE_IMMEDIATE

Flag to tell parse that expression will be evaluated immediately. I.e. we're not creating class files for future execution.

See Also:

Constant Field Values

PARSE_CURRENT_NAMES

public static final int PARSE_CURRENT_NAMES

Flag to tell parse to use current NameLookup. As opposed to creating a new instance.

See Also:

Constant Field Values

PARSE_ONE_LINE

public static final int PARSE_ONE_LINE

Flag to tell parse to only read a single line if possible. Multiple lines may be read if syntactically required.

See Also:

Constant Field Values

PARSE_PROLOG

public static final int PARSE_PROLOG

Flag to tell parser to continue until we have the module name. The parser is allowed to continue further, but must stop before any module import.

See Also:

Constant Field Values

PARSE_FOR_EVAL

public static final int PARSE_FOR_EVAL

See Also:

Constant Field Values

PARSE_FOR_APPLET

public static final int PARSE_FOR_APPLET

See Also:

Constant Field Values

PARSE_FOR_SERVLET

public static final int PARSE_FOR_SERVLET

See Also:

Constant Field Values

PARSE_EXPLICIT

public static final int PARSE_EXPLICIT

Compilation explicitly requested, not just because of an import.

See Also:

Constant Field Values

PARSE_INTERACTIVE_MODULE

public static final int PARSE_INTERACTIVE_MODULE

See Also:

Constant Field Values

PARSE_EMIT_MAIN

public static final int PARSE_EMIT_MAIN

See Also:

Constant Field Values

PARSE_FOR_LINT

public static final int PARSE_FOR_LINT

See Also:

Constant Field Values

requirePedantic

public static boolean requirePedantic

VALUE_NAMESPACE

public static final int VALUE_NAMESPACE

See Also:

Constant Field Values

FUNCTION_NAMESPACE

public static final int FUNCTION_NAMESPACE

See Also:

Constant Field Values

NAMESPACE_PREFIX_NAMESPACE

public static final int NAMESPACE_PREFIX_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

Language

protected Language()

Method Detail

getDefaultLanguage

public static Language getDefaultLanguage()

setCurrentLanguage

public static void setCurrentLanguage(Language language)

setSaveCurrent

public static Language setSaveCurrent(Language language)

restoreCurrent

public static void restoreCurrent(Language saved)

getLanguages

public static java.lang.String[][] getLanguages()

Get a list of all available languages

registerLanguage

public static void registerLanguage(java.lang.String[] langMapping)

Add a language to the list.

Parameters:

langMapping - is a language definition, the first element is the language name, subsequent indexes are file types that might cause the language to be used and the final index is the name of the class that implements the language.

detect

public static Language detect(java.io.InputStream in)
                       throws java.io.IOException

Detect the programming language of a file based on its first line.

Returns:

a suitable Language or null if we didn't recognize one.

Throws:

java.io.IOException

detect

public static Language detect(gnu.kawa.io.InPort port)
                       throws java.io.IOException

Detect the programming language of a file based on its first line.

Returns:

a suitable Language or null if we didn't recognize one.

Throws:

java.io.IOException

detect

public static Language detect(java.lang.String line)

Detect the programming language of a file based on its first line.

Parameters:

line - the first input line

Returns:

a suitable Language or null if we didn't recognize one.

getInstanceFromFilenameExtension

public static Language getInstanceFromFilenameExtension(java.lang.String filename)

getInstance

public static Language getInstance(java.lang.String name)

Look for a language with the given name or extension. If name is null, look for the first language available.

getInstance

public static Language getInstance(java.lang.String langName,
                                   java.lang.Class langClass)

isTrue

public boolean isTrue(java.lang.Object value)

Test if a value is considered "true" in this language. Throws an exception if value can't be used in a boolean context. Use booleanValue to catch that exception.

booleanValue

public int booleanValue(java.lang.Object value)

Test if a value is considered "true" in this language.

Returns:

1 if true; 0 if false; -1 if not a valid boolean

booleanObject

public java.lang.Object booleanObject(boolean b)

noValue

public java.lang.Object noValue()

The value to return for a "void" result.

hasSeparateFunctionNamespace

public boolean hasSeparateFunctionNamespace()

True if functions are in a separate name space from variable. Is true for e.g. Common Lisp, Emacs Lisp; false for Scheme.

getEnvironment

public final Environment getEnvironment()

Get current user environment.

getNewEnvironment

public final Environment getNewEnvironment()

getLangEnvironment

public Environment getLangEnvironment()

lookupBuiltin

public NamedLocation lookupBuiltin(Symbol name,
                                   java.lang.Object property,
                                   int hash)

define

public void define(java.lang.String sym,
                   java.lang.Object p)

Enter a value into the current environment.

getNamedType

public Type getNamedType(java.lang.String name)

Get the corresponding Type for a given name. This is currently used as a hook in the conversion of type designators to types. LispLanguage uses it to check for package style type designators such as emacs:buffer, and CommonLisp uses it to check for a type designator "boolean", so that is can return the appropriate boolean type. This is a bit over-specialised, but it beats actually overriding getTypeFor(String) in LispLanguage, CommonLisp just for these minor changes... FIXME!

Parameters:

name - The name of a type to search for.

Returns:

The corresponding Type if a suitable one can be found, otherwise null.

defAliasStFld

protected void defAliasStFld(java.lang.String name,
                             java.lang.String cname,
                             java.lang.String fname)

Declare in the current Environment a variable aliased to a static field.

defProcStFld

protected void defProcStFld(java.lang.String name,
                            java.lang.String cname,
                            java.lang.String fname)

Declare in the current Environment a procedure bound to a static field.

Parameters:

name - the procedure's source-level name.

cname - the name of the class containing the field.

fname - the name of the field, which should be a static final field whose type extends gnu.mapping.Procedure.

defProcStFld

protected void defProcStFld(Symbol sym,
                            java.lang.String cname,
                            java.lang.String fname)

defProcStFld

protected void defProcStFld(java.lang.String name,
                            java.lang.String cname)

Declare in the current Environment a procedure bound to a static field.

Parameters:

name - the procedure's source-level name.

cname - the name of the class containing the field. The name of the field is the mangling of name.

defProcStFldAs

protected void defProcStFldAs(java.lang.String asName,
                              java.lang.String cname,
                              java.lang.String mname)

Declare by name in the current environment a procedure bound to a static field.

Parameters:

asName - The procedure's source-level name.

cname - The name of the class containing the field.

mname - The name of the (mangled) field in cname

defineFunction

public final void defineFunction(Named proc)

Enter a named function into the current environment.

defineFunction

public void defineFunction(java.lang.String name,
                           java.lang.Object proc)

Enter a function into the current environment. Same as define(name,proc) for Scheme, but not for (say) Common Lisp.

getEnvPropertyFor

public java.lang.Object getEnvPropertyFor(java.lang.reflect.Field fld,
                                          java.lang.Object value)

getEnvPropertyFor

public java.lang.Object getEnvPropertyFor(Declaration decl)

loadClass

public void loadClass(java.lang.String name)
               throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getSymbol

public Symbol getSymbol(java.lang.String name)

lookup

public java.lang.Object lookup(java.lang.String name)

getFormat

public gnu.kawa.format.AbstractFormat getFormat(boolean readable)

getOutputConsumer

public Consumer getOutputConsumer(java.io.Writer out)

getName

public java.lang.String getName()

getExtensions

public java.util.List<java.lang.String> getExtensions()

isValidJavaName

public static boolean isValidJavaName(java.lang.String name)

mangleName

public static java.lang.String mangleName(java.lang.String name,
                                          int kind)

Convert a string to a safe Java identifier.

Parameters:

kind - -1 - non-reversible; 0: reversible, except that '$' is not mapped; 1: reversible

getLexer

public abstract Lexer getLexer(gnu.kawa.io.InPort inp,
                               SourceMessages messages)

getCompilationClass

public java.lang.String getCompilationClass()

getCompilation

public final Compilation getCompilation(SourceMessages messages,
                                        NameLookup lexical)

getCompilation

public final Compilation getCompilation(Lexer lexer,
                                        int options,
                                        ModuleInfo info)

parse

public final Compilation parse(gnu.kawa.io.InPort port,
                               SourceMessages messages,
                               int options)
                        throws java.io.IOException,
                               SyntaxException

Parse one or more expressions.

Parameters:

port - the InPort to read the expressions from.

messages - where to send error messages and warnings

options - various flags, including PARSE_IMMEDIATE and PARSE_ONE_LINE

Returns:

a new Compilation. May return null if PARSE_ONE_LINE on end-of-file.

Throws:

java.io.IOException

SyntaxException

parse

public final Compilation parse(gnu.kawa.io.InPort port,
                               SourceMessages messages,
                               int options,
                               ModuleInfo info)
                        throws java.io.IOException,
                               SyntaxException

Throws:

java.io.IOException

SyntaxException

parse

public final Compilation parse(Lexer lexer,
                               int options,
                               ModuleInfo info)
                        throws java.io.IOException,
                               SyntaxException

Throws:

java.io.IOException

SyntaxException

parse

public final boolean parse(Compilation tr)
                    throws java.io.IOException,
                           SyntaxException

Throws:

java.io.IOException

SyntaxException

parse

public abstract boolean parse(Compilation comp,
                              int options)
                       throws java.io.IOException,
                              SyntaxException

Throws:

java.io.IOException

SyntaxException

resolve

public void resolve(Compilation comp)

Perform any need post-processing after we've read all the modules to be compiled. Using a separate pass allows compiling mutually recursive modules.

getTypeFor

public Type getTypeFor(java.lang.Class clas)

getLangTypeFor

public final Type getLangTypeFor(Type type)

formatType

public java.lang.String formatType(Type type)

getTypeFor

public Type getTypeFor(java.lang.String name)

getTypeFor

public Type getTypeFor(java.lang.Object spec,
                       boolean lenient)

Convert a "type value" to a Type. This is used to process types from source code. Normally, an identifier that resolves to a class name should resolve to the raw ClassType, rather than a language specific class (which might e.g. use a different constructor). These may be exceptions: specifically, given java.lang.String, we do want to use language-specific conversion to String.

encodeType

public java.lang.String encodeType(Type type)

Encode this type as a parseable string. Stored in SourceType or SourceMethodType annotations.

Returns:

A string suitable for decodeType(gnu.bytecode.Type, java.lang.String, gnu.bytecode.ParameterizedType), or null if the type is "uninteresting" in the sense we can infer it from the Java typing.

decodeType

public Type decodeType(Type javaType,
                       java.lang.String annotType,
                       ParameterizedType parameterizedType)

asType

public final Type asType(java.lang.Object spec)

"Coerce" a language-specific "type specifier" object to a Type.

getTypeFor

public final Type getTypeFor(Expression exp)

getTypeFor

public Type getTypeFor(Expression exp,
                       boolean lenient)

Interpreting exp as a type specifier, get the actual type. (Does not get the type "of" but exp treats/casts exp "to" ("as") a type).

unionType

public static Type unionType(Type t1,
                             Type t2)

declFromField

public Declaration declFromField(ModuleExp mod,
                                 java.lang.Object fvalue,
                                 Field fld)

getNamespaceOf

public int getNamespaceOf(Declaration decl)

Return the namespace (e.g value or function) of a Declaration. Return a bitmask of all the namespaces "covered" by the Declaration. Note this isn't a namespace in the XML sense; if a Declaration has a specific namespace URI, then that is part of its symbol. This namespace bitmap is a separate dimension, for the use of languages that have separate namespaces for different kinds of declarations, such as variables and functions.

hasNamespace

public boolean hasNamespace(Declaration decl,
                            int namespace)

True if a Declaration is in the specified namespace.

Parameters:

namespace - normally a bitmask as returned by getNamespaceOf.

coerceFromObject

public java.lang.Object coerceFromObject(java.lang.Class clas,
                                         java.lang.Object obj)

coerceToObject

public java.lang.Object coerceToObject(java.lang.Class clas,
                                       java.lang.Object obj)

setDefaults

public static void setDefaults(Language lang)

getPrimaryPrompt

public java.lang.String getPrimaryPrompt()

getSecondaryPrompt

public java.lang.String getSecondaryPrompt()

eval

public final java.lang.Object eval(java.lang.String string)
                            throws java.lang.Throwable

Return the result of evaluating a string as a source expression.

Throws:

java.lang.Throwable

eval

public final java.lang.Object eval(java.io.Reader in)
                            throws java.lang.Throwable

Evaluate expression(s) read from a Reader. This just calls eval(InPort).

Throws:

java.lang.Throwable

eval

public final java.lang.Object eval(gnu.kawa.io.InPort port)
                            throws java.lang.Throwable

Evaluate expression(s) read from an InPort.

Throws:

java.lang.Throwable

eval

public final void eval(java.lang.String string,
                       java.io.Writer out)
                throws java.lang.Throwable

Evaluate a string and write the result value(s) on a Writer.

Throws:

java.lang.Throwable

eval

public final void eval(java.lang.String string,
                       PrintConsumer out)
                throws java.lang.Throwable

Evaluate a string and write the result value(s) to a PrintConsumer. This is to disambiguate calls using OutPort or XMLPrinter, which are both Writer and Consumer.

Throws:

java.lang.Throwable

eval

public final void eval(java.lang.String string,
                       Consumer out)
                throws java.lang.Throwable

Evaluate a string and write the result value(s) to a Consumer.

Throws:

java.lang.Throwable

eval

public final void eval(java.io.Reader in,
                       java.io.Writer out)
                throws java.lang.Throwable

Read expressions from a Reader and write the result to a Writer.

Throws:

java.lang.Throwable

eval

public void eval(java.io.Reader in,
                 Consumer out)
          throws java.lang.Throwable

Read expressions from a Reader and write the result to a Consumer.

Throws:

java.lang.Throwable

eval

public void eval(gnu.kawa.io.InPort port,
                 CallContext ctx)
          throws java.lang.Throwable

Throws:

java.lang.Throwable

runAsApplication

public void runAsApplication(java.lang.String[] args)