org.jace.proxy

Class ProxyGenerator

java.lang.Object

org.jace.proxy.ProxyGenerator

public class ProxyGenerator
extends Object

Generates a C++ proxy class for use with the Jace library.

Author:

Toby Reyelts, Gili Tzabari

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyGenerator.AcceptAll Accepts all classes.
static class	ProxyGenerator.AccessibilityType Indicates the member accessibility that proxies should expose.
static class	ProxyGenerator.Builder Builds a ProxyGenerator.
static class	ProxyGenerator.FilteringCollection Accepts a collection of classes.
static class	ProxyGenerator.InvokeStyle Type of method invocation.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginNamespace(Writer output) Generates the opening of a namespace.
void	generateFieldDeclarations(Writer output, boolean forPeer) Generates the field declarations.
void	generateFieldDefinitions(Writer output) Same as generateFieldDefinitions(output, false).
void	generateFieldDefinitions(Writer output, boolean forPeer) Generate the field definitions.
void	generateHeader(Writer output) Generates the proxy header.
void	generateJaceDefinitions(Writer output) Same as generateJaceDefinitions(output, false).
void	generateJaceDefinitions(Writer output, boolean forPeer) Generate the jace-specific methods.
void	generateMethodDeclaration(Writer output, MetaClass metaClass, ClassMethod method, ProxyGenerator.InvokeStyle invokeStyle) Generates the method declaration.
void	generateMethodDefinitions(Writer output, boolean forPeer) Generate the method definitions.
void	generateSource(Writer output) Generates the proxy source code.
Set<MetaClass>	getDependentClasses(boolean fullyDependent) Returns the classes which the class we are generating is dependent upon.
String	getInitializerValue() Same as getInitializerValue(false).
String	getInitializerValue(boolean forPeer) Returns the initializer list for the current class.
void	includeDependentHeaders(Writer output) Includes the headers for the super-class and all implemented interfaces.
void	includeStandardHeaders(Writer output, boolean forPeer) Generate includes for the Jace library headers, which should always be included.
void	includeStandardSourceHeaders(Writer output) Generates the source-code includes.
static void	main(String[] args) Generates a C++ proxy for a java class.
void	makeForwardDeclarations(Writer output) Make forward declarations for all of the types for which the class is dependent.
void	writeProxy(File outputHeaders, File outputSources) Generates the C++ proxy (header and source) for the specified class.

Methods inherited from class java.lang.Object

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

Method Detail

generateHeader

public void generateHeader(Writer output)
                    throws IOException

Generates the proxy header.

Parameters:

output - the output writer

Throws:

IOException - if an I/O exception occurs while writing the header file

generateSource

public void generateSource(Writer output)
                    throws IOException

Generates the proxy source code.

Parameters:

output - the output writer

Throws:

IOException - if an I/O exception occurs while writing the source file

includeStandardSourceHeaders

public void includeStandardSourceHeaders(Writer output)
                                  throws IOException

Generates the source-code includes.

Parameters:

output - the output writer

Throws:

IOException - if an I/O exception occurs while writing

generateMethodDefinitions

public void generateMethodDefinitions(Writer output,
                             boolean forPeer)
                               throws IOException

Generate the method definitions.

Parameters:

output - the output writer

forPeer - true if the methods are being generated for a peer, false for a proxy

Throws:

IOException - if an error occurs while writing

generateFieldDefinitions

public void generateFieldDefinitions(Writer output)
                              throws IOException

Same as generateFieldDefinitions(output, false).

Parameters:

output - the output writer

Throws:

IOException - if an error occurs while writing

See Also:

generateFieldDefinitions(Writer, boolean)

generateFieldDefinitions

public void generateFieldDefinitions(Writer output,
                            boolean forPeer)
                              throws IOException

Generate the field definitions.

Parameters:

output - the output writer

forPeer - true if the fields are being generated for a peer, false for a proxy

Throws:

IOException - if an error occurs while writing

generateJaceDefinitions

public void generateJaceDefinitions(Writer output)
                             throws IOException

Same as generateJaceDefinitions(output, false).

Parameters:

output - the output writer

Throws:

IOException - if an error occurs while writing

See Also:

generateJaceDefinitions(Writer, boolean).

generateJaceDefinitions

public void generateJaceDefinitions(Writer output,
                           boolean forPeer)
                             throws IOException

Generate the jace-specific methods.

Parameters:

output - the output writer

forPeer - true if the fields are being generated for a peer, false for a proxy

Throws:

IOException - if an error occurs while writing

getInitializerValue

public String getInitializerValue()

Same as getInitializerValue(false).

Returns:

the initializer list

See Also:

defineInitializerValue(boolean)

getInitializerValue

public String getInitializerValue(boolean forPeer)

Returns the initializer list for the current class. For example, ": Object(), OutputStream()" This could probably be placed in MetaClass. It might not hurt to put the initializers in some sort of array instead of a formatted String. This method used to include interfaces in the initializer list, but now that interfaces have a default constructor that does what we want, they are no longer included.

Parameters:

forPeer - true if the methods are being generated for a peer, false for a proxy

Returns:

the initializer list

generateMethodDeclaration

public void generateMethodDeclaration(Writer output,
                             MetaClass metaClass,
                             ClassMethod method,
                             ProxyGenerator.InvokeStyle invokeStyle)
                               throws IOException

Generates the method declaration.

Parameters:

output - the output writer

metaClass - the MetaClass describing the class

method - the method

invokeStyle - the method invocation style

Throws:

IOException - if an error occurs while writing

generateFieldDeclarations

public void generateFieldDeclarations(Writer output,
                             boolean forPeer)
                               throws IOException

Generates the field declarations.

Parameters:

output - the output writer

forPeer - true if the fields are being generated for a peer, false for a proxy

Throws:

IOException - if an error occurs while writing

beginNamespace

public void beginNamespace(Writer output)
                    throws IOException

Generates the opening of a namespace.

Parameters:

output - the output writer

Throws:

IOException - if an error occurs while writing

includeStandardHeaders

public void includeStandardHeaders(Writer output,
                          boolean forPeer)
                            throws IOException

Generate includes for the Jace library headers, which should always be included.

Parameters:

output - the output writer

forPeer - true if the methods are being generated for a peer, false for a proxy

Throws:

IOException - if an error occurs while writing

includeDependentHeaders

public void includeDependentHeaders(Writer output)
                             throws IOException

Includes the headers for the super-class and all implemented interfaces. This is necessary, because we can't inherit from a class unless it is fully defined.

Parameters:

output - the output writer

Throws:

IOException - if an error occurs while writing

makeForwardDeclarations

public void makeForwardDeclarations(Writer output)
                             throws IOException

Make forward declarations for all of the types for which the class is dependent.

Parameters:

output - the output writer

Throws:

IOException - if an error occurs while writing

getDependentClasses

public Set<MetaClass> getDependentClasses(boolean fullyDependent)

Returns the classes which the class we are generating is dependent upon.

Parameters:

fullyDependent - true if the method is to return classes which need to be fully defined before reference (such as fields). Otherwise, false if the method is to return classes which may be forward declared (array elements, exceptions and all other parameter types).

Returns:

a list of the dependee MetaClasses for this class. It does not include the super class, and the interfaces implemented by this class.

writeProxy

public void writeProxy(File outputHeaders,
              File outputSources)
                throws IOException

Generates the C++ proxy (header and source) for the specified class.

Parameters:

outputHeaders - the directory to write the header file to

outputSources - the directory to write the source file to

Throws:

IOException - if an error occurs while writing the proxy files

main

public static void main(String[] args)

Generates a C++ proxy for a java class.

Parameters:

args - the command-line argument