com.goldencode.p2j.uast

Class LegacyBuiltInClassSanitizer

java.lang.Object

com.goldencode.p2j.uast.LegacyBuiltInClassSanitizer

public class LegacyBuiltInClassSanitizer
extends java.lang.Object

This tool allows an automated approach at sanitizing the LegacySignature annotations for hand-written legacy builtin classes, which exists in the com.goldencode.p2j.oo package.

To run this in test mode (which will just print the problems), use the (t)est mode.

The following LegacySignature attributes are verified and injected (if possible):

• 'qualified', for object methods or parameters
• 'extent', for extent methods or parameters - these are not injected, as the Java signature for the method doesn't allow encoding of the extent type (fixed or dynamic).
• 'returns', for method return type.

If the parameter count at LegacySignature doesn't match the paramter count at the Java method definition, a message will be logged. TODO: sanitize full Java method signature against the LegacySignature.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	testMode Flag indicating if we are in test mode - no changes will be made to source code.

Constructor Summary

Constructors

Constructor and Description
LegacyBuiltInClassSanitizer()

Method Summary

Modifier and Type	Method and Description
private static int	countParenthesis(java.lang.String line) Count the number of opened parenthesis.
private static int	findLegacySignatureLine(javassist.bytecode.CodeAttribute code, java.util.List<java.lang.String> clsLines) Find the line which holds the LegacySignature annotation for the given method.
private static int	findLegacySignatureLine(javassist.CtClass cc, javassist.CtMethod m, java.util.List<java.lang.String> clsLines) Find the line which holds the LegacySignature annotation for the given method.
private static int	findLegacySignatureLine(int firstCodeLine, java.util.List<java.lang.String> clsLines) Find the line which holds the LegacySignature annotation for the given method, by walking 'up' until the LegacySignature is found.
private static java.lang.String	getLegacyType(javassist.bytecode.SignatureAttribute.MethodSignature sig, javassist.bytecode.SignatureAttribute.ClassType tp) Find the legacy OO type.
private static java.util.List<java.lang.String>	injectMethodReturn(javassist.CtClass cc, javassist.CtMethod m, java.util.List<java.lang.String> clsLines) Inject the returns attribute (with the method's legacy return type) at the LegacySignature annotation.
private static java.util.List<java.lang.String>	injectQualifiedParameter(javassist.CtClass cc, javassist.CtMethod m, int pidx, java.util.List<java.lang.String> clsLines) Inject the qualified attribute (with the parameter's legacy qualified type) at the LegacyParameter annotation.
private static java.util.List<java.lang.String>	injectQualifiedReturn(javassist.CtClass cc, javassist.CtMethod m, java.util.List<java.lang.String> clsLines) Inject the qualified attribute (with the method's legacy qualified type) at the LegacySignature annotation.
static void	main(java.lang.String[] args) Run the tool.
private static boolean	parameterMatch(javassist.CtMethod m, java.lang.String sig) Check if the given Java-style signature matches the specified method.
private static java.util.List<java.lang.String>	readSourceCode(javassist.CtClass cc) Read the Java source code for the given class.
private static void	writeSourceCode(javassist.CtClass cc, java.util.List<java.lang.String> clsLines) Write the santizied Java source code for the given class.

Methods inherited from class java.lang.Object

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

Field Detail

testMode

private static boolean testMode

Flag indicating if we are in test mode - no changes will be made to source code.

Constructor Detail

LegacyBuiltInClassSanitizer

public LegacyBuiltInClassSanitizer()

Method Detail

injectMethodReturn

private static java.util.List<java.lang.String> injectMethodReturn(javassist.CtClass cc,
                                                                   javassist.CtMethod m,
                                                                   java.util.List<java.lang.String> clsLines)
                                                            throws java.lang.Exception

Inject the returns attribute (with the method's legacy return type) at the LegacySignature annotation.

Parameters:

cc - The target class.

m - The target method.

clsLines - The source code.

Returns:

The read source code.

Throws:

java.lang.Exception

injectQualifiedReturn

private static java.util.List<java.lang.String> injectQualifiedReturn(javassist.CtClass cc,
                                                                      javassist.CtMethod m,
                                                                      java.util.List<java.lang.String> clsLines)
                                                               throws java.lang.Exception

Inject the qualified attribute (with the method's legacy qualified type) at the LegacySignature annotation. Only if the Java method returns object.

Parameters:

cc - The target class.

m - The target method.

clsLines - The source code.

Returns:

The read source code.

Throws:

java.lang.Exception

injectQualifiedParameter

private static java.util.List<java.lang.String> injectQualifiedParameter(javassist.CtClass cc,
                                                                         javassist.CtMethod m,
                                                                         int pidx,
                                                                         java.util.List<java.lang.String> clsLines)
                                                                  throws java.lang.Exception

Inject the qualified attribute (with the parameter's legacy qualified type) at the LegacyParameter annotation. Only if the Java parameter's type is object.

Parameters:

cc - The target class.

m - The target method.

pidx - The parameter index.

clsLines - The source code.

Returns:

The read source code.

Throws:

java.lang.Exception

findLegacySignatureLine

private static int findLegacySignatureLine(javassist.CtClass cc,
                                           javassist.CtMethod m,
                                           java.util.List<java.lang.String> clsLines)
                                    throws java.lang.Exception

Find the line which holds the LegacySignature annotation for the given method.

This uses a heuristic to find the Java source code for the specified method.

Parameters:

cc - The target class.

m - The target method.

clsLines - The source code.

Returns:

The found line, or -1 if can't be resolved.

Throws:

java.lang.Exception

parameterMatch

private static boolean parameterMatch(javassist.CtMethod m,
                                      java.lang.String sig)
                               throws javassist.NotFoundException

Check if the given Java-style signature matches the specified method.

Parameters:

m - The target method.

sig - The candidate signature.

Returns:

true if the method has the same signature.

Throws:

javassist.NotFoundException

countParenthesis

private static int countParenthesis(java.lang.String line)

Count the number of opened parenthesis.

Parameters:

line - The line of code.

Returns:

The number of opened (or closed) parenthesis.

findLegacySignatureLine

private static int findLegacySignatureLine(javassist.bytecode.CodeAttribute code,
                                           java.util.List<java.lang.String> clsLines)

Find the line which holds the LegacySignature annotation for the given method.

This uses the disassembled bytecode to position on the method code, and walk 'up' until the LegacySignature is found.

Parameters:

code - The method's code attribute.

clsLines - The source code.

Returns:

The found line, or -1 if can't be resolved.

findLegacySignatureLine

private static int findLegacySignatureLine(int firstCodeLine,
                                           java.util.List<java.lang.String> clsLines)

Find the line which holds the LegacySignature annotation for the given method, by walking 'up' until the LegacySignature is found.

Parameters:

firstCodeLine - The method's first code line.

clsLines - The source code.

Returns:

The found line, or -1 if can't be resolved.

getLegacyType

private static java.lang.String getLegacyType(javassist.bytecode.SignatureAttribute.MethodSignature sig,
                                              javassist.bytecode.SignatureAttribute.ClassType tp)
                                       throws java.lang.ClassNotFoundException

Find the legacy OO type.

Parameters:

sig - The method signature.

tp - The type to resolve.

Returns:

The found legacy type.

Throws:

java.lang.ClassNotFoundException

readSourceCode

private static java.util.List<java.lang.String> readSourceCode(javassist.CtClass cc)

Read the Java source code for the given class.

Parameters:

cc - The class to be read.

Returns:

The source code.

writeSourceCode

private static void writeSourceCode(javassist.CtClass cc,
                                    java.util.List<java.lang.String> clsLines)

Write the santizied Java source code for the given class.

Parameters:

cc - The class to be written.

clsLines - The source code.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Run the tool. Use (t)est to run in 'test mode', with no side-effects for existing code - this will only report any found problems in the com.goldencode.p2j.oo package.

Parameters:

args - The arguments.

Throws:

java.lang.Exception