com.goldencode.p2j.uast

Class FuzzyMethodLookup

java.lang.Object

com.goldencode.p2j.uast.FuzzyMethodLookup

Direct Known Subclasses:

FuzzyMethodCvt, FuzzyMethodRt

public abstract class FuzzyMethodLookup
extends java.lang.Object

Implements the rules to perform fuzzy method lookup.

Constructor Summary

Constructors

Constructor and Description
FuzzyMethodLookup()

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.List<MatchMetrics>	candidates(java.lang.String name, int num, int access, boolean isStatic, boolean internal, boolean first, java.util.Set<SignatureKey> exist) Get the list of all possible methods that could match in this class AND its parent classes.
private boolean	filterList(java.util.List<MatchMetrics> list, java.util.function.Predicate<MatchMetrics> test, int idx, java.lang.String callerType, java.lang.String[] error) Check if there is only 1 or more possible match for the given predicate, if so then remove all candidates from the list except for the possible matches.
private java.lang.String	fromJava(java.lang.String type) Convert the specified Java-style type to a legacy BDT compatible type, if possible.
protected MethodSearchResult	fuzzyMethodLookup(java.lang.String name, ParameterKey[] caller, int access, boolean isStatic, boolean internal, Aast node) Find the named method based on a fuzzy signature match.
protected abstract java.lang.String	getClassName() Get the class name where this method lookup starts from.
private int	getExtent(java.lang.String sig) Get the extent value from a parameter's type.
protected abstract boolean	isImplemented(java.lang.String caller, java.lang.String callee) Detect if the callee class is an instance of an implemented interface of the caller class.
protected abstract boolean	isInheritedFrom(java.lang.String caller, java.lang.String callee, java.lang.Runnable incrementer) Detect if the callee class is an instance of a parent class or an implemented interface of a parent class, of the caller.
private boolean	isNarrowingTypeMatch(java.lang.String caller, java.lang.String callee, java.lang.Runnable incrementer) Check if the callee's type can be written back to a wider caller's type, when viewed from the caller to callee, this looks like a "narrowing" operation.
protected abstract boolean	isSetParam(java.lang.String method) Reports if the class name is Progress.Lang.ParameterList and the method name is setParameter().
private boolean	isWideningTypeMatch(java.lang.String caller, java.lang.String callee, java.lang.Runnable incrementer) Check if the caller's type can be matched to a wider type in the callee's signature.
private boolean	processExactMatches(java.util.List<MatchMetrics> list, java.util.function.Predicate<MatchMetrics> exactMatch) Remove any non-exact matches from the given list.
private void	processExtentMatches(java.util.List<MatchMetrics> list, int callerExtVal, int idx) Remove any candidates from the list which do not match the caller's extent.

Methods inherited from class java.lang.Object

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

Constructor Detail

FuzzyMethodLookup

public FuzzyMethodLookup()

Method Detail

getClassName

protected abstract java.lang.String getClassName()

Get the class name where this method lookup starts from.

Returns:

See above.

isImplemented

protected abstract boolean isImplemented(java.lang.String caller,
                                         java.lang.String callee)

Detect if the callee class is an instance of an implemented interface of the caller class.

Parameters:

caller - The caller type.

callee - The callee type.

Returns:

true if the given class is an implemented interface in this class.

isInheritedFrom

protected abstract boolean isInheritedFrom(java.lang.String caller,
                                           java.lang.String callee,
                                           java.lang.Runnable incrementer)

Detect if the callee class is an instance of a parent class or an implemented interface of a parent class, of the caller.

Parameters:

caller - The caller type.

callee - The callee type to check.

incrementer - Code to be executed to increment the inheritance level.

Returns:

true if the given class is a parent class or an implemented interface of a parent class.

isSetParam

protected abstract boolean isSetParam(java.lang.String method)

Reports if the class name is Progress.Lang.ParameterList and the method name is setParameter().

Parameters:

method - The method name.

Returns:

true if this is a setParameter call.

candidates

protected abstract java.util.List<MatchMetrics> candidates(java.lang.String name,
                                                           int num,
                                                           int access,
                                                           boolean isStatic,
                                                           boolean internal,
                                                           boolean first,
                                                           java.util.Set<SignatureKey> exist)

Get the list of all possible methods that could match in this class AND its parent classes. The actual types are not checked but the method name, access mode, static/instance and number of parameters must all match.

Parameters:

name - Method name.

num - Number of parameters.

access - Access mode (KW_PUBLIC, KW_PROTECTD or KW_PRIVATE).

isStatic - If true, only static methods will be looked up. Otherwise any method can be returned.

internal - true if the lookup is internal to the current class definition.

first - true if the first match should be immediately returned as the result.

exist - The set of existing methods already represented in the list.

Returns:

List of possible methods that match. This may be an empty list if no match exists.

fuzzyMethodLookup

protected MethodSearchResult fuzzyMethodLookup(java.lang.String name,
                                               ParameterKey[] caller,
                                               int access,
                                               boolean isStatic,
                                               boolean internal,
                                               Aast node)

Find the named method based on a fuzzy signature match. This method will search up the parent hierarchy (recursively) if no fuzzy match is found in the current class.

Parameters:

name - Resource name.

caller - Method call signature.

access - Access mode (KW_PUBLIC, KW_PROTECTD or KW_PRIVATE).

isStatic - If true, only static methods will be looked up. Otherwise any method can be returned.

internal - true if the lookup is internal to the current class definition.

node - The AST referencing this method.

Returns:

Resource found or null if no match exists.

fromJava

private java.lang.String fromJava(java.lang.String type)

Convert the specified Java-style type to a legacy BDT compatible type, if possible.

Parameters:

type - The Java type, in jobject> extends< format.

Returns:

The converted type (if conversion was made) or the original type, otherwise.

isWideningTypeMatch

private boolean isWideningTypeMatch(java.lang.String caller,
                                    java.lang.String callee,
                                    java.lang.Runnable incrementer)

Check if the caller's type can be matched to a wider type in the callee's signature.

Primitive types widen as follows:

  Caller Type       Callee Parameter Types
 --------------     ----------------------
 integer            int64, decimal
 int64              decimal
 character          longchar
 date               datetime, datetime-tz
 datetime           datetime-tz
 

Object types widen by these rules:

1. We check if the callee matches any of the interfaces implemented by the caller type's specific class.
2. We check if the callee matches any of the parent class hierarchy (and their implemented interfaces) of the caller type's specific class.
3. We check if the callee is Progress.Lang.Object. This check has lowest priority.

Parameters:

caller - The caller's passed instance's data type.

callee - The candidate callee method's parameter data type.

incrementer - Code to be executed to increment the inheritance level.

Returns:

true if a widening operation is possible.

isNarrowingTypeMatch

private boolean isNarrowingTypeMatch(java.lang.String caller,
                                     java.lang.String callee,
                                     java.lang.Runnable incrementer)

Check if the callee's type can be written back to a wider caller's type, when viewed from the caller to callee, this looks like a "narrowing" operation.

Primitive types narrow as follows:

  Caller Type       Callee Parameter Types
 --------------     ----------------------
 int64              integer
 decimal            integer, int64
 longchar           character
 datetime           date
 datetime-tz        date, datetime
 

Object types narrow by these rules:

1. We check if the callee matches a child class of the caller type's specific class. The nearest child class is matched with highest priority.

Parameters:

caller - The caller's passed instance's data type.

callee - The candidate callee method's parameter data type.

incrementer - Code to be executed to increment the inheritance level.

Returns:

true if a narrowing operation is possible.

filterList

private boolean filterList(java.util.List<MatchMetrics> list,
                           java.util.function.Predicate<MatchMetrics> test,
                           int idx,
                           java.lang.String callerType,
                           java.lang.String[] error)

Check if there is only 1 or more possible match for the given predicate, if so then remove all candidates from the list except for the possible matches.

Parameters:

list - The list to edit.

test - The predicate to test.

idx - The parameter index for error messages.

callerType - The caller type for error messages.

error - A location to store an error message for the caller.

processExactMatches

private boolean processExactMatches(java.util.List<MatchMetrics> list,
                                    java.util.function.Predicate<MatchMetrics> exactMatch)

Remove any non-exact matches from the given list.

Parameters:

list - The list to edit.

exactMatch - The test for an exact match.

Returns:

true if edits were made.

processExtentMatches

private void processExtentMatches(java.util.List<MatchMetrics> list,
                                  int callerExtVal,
                                  int idx)

Remove any candidates from the list which do not match the caller's extent. The following are possible matches:

• Neither the caller nor the parameter definition have an extent specification.
• Both the caller and the parameter definition have an indeterminate extent.
• The caller has a fixed extent value and the parameter definition has the same fixed extent value.
• The caller has a fixed extent value and the parameter definition has an indeterminate extent. This is a fuzzy match (all the above criteria are the same as exact matches).

Parameters:

list - The list of candidates.

callerExtVal - Caller's extent value (-1 means indeterminate, 0 is scalar and any positive value is the fixed extent).

idx - Parameter number being processed.

getExtent

private int getExtent(java.lang.String sig)

Get the extent value from a parameter's type. If dynamic extent, return -1.

Parameters:

sig - The parameter's type.

Returns:

The extent value.