Package org.jctools.queues.varhandle

Class JavaParsingVarHandleArrayQueueGenerator

java.lang.Object

com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

org.jctools.queues.varhandle.JavaParsingVarHandleQueueGenerator

org.jctools.queues.varhandle.JavaParsingVarHandleArrayQueueGenerator

All Implemented Interfaces:

com.github.javaparser.ast.visitor.VoidVisitor<Void>, JCToolsGenerator

Direct Known Subclasses:

JavaParsingVarHandleUnpaddedArrayQueueGenerator

public class JavaParsingVarHandleArrayQueueGenerator
extends JavaParsingVarHandleQueueGenerator

This generator takes in an JCTools 'ArrayQueue' Java source file and patches Unsafe accesses into VarHandle. It outputs a Java source file with these patches.

An 'ArrayQueue' is one that is backed by a circular array and use a producerLimit and a consumerLimit field to track the positions of each.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	JavaParsingVarHandleArrayQueueGenerator.FieldInfo	Helper class to track field information

Field Summary

Fields inherited from class org.jctools.queues.varhandle.JavaParsingVarHandleQueueGenerator

GEN_DIRECTIVE_CLASS_CONTAINS_ORDERED_FIELD_ACCESSORS, GEN_DIRECTIVE_METHOD_IGNORE, hasVarHandleFields, sourceFileName

Constructor Summary

Constructors

Constructor	Description
JavaParsingVarHandleArrayQueueGenerator(String sourceFileName)

Method Summary

Modifier and Type	Method	Description
private com.github.javaparser.ast.body.InitializerDeclaration	createVarHandleStaticInitializerWithTypes(String className, List<JavaParsingVarHandleArrayQueueGenerator.FieldInfo> fieldInfos)	Creates a static initializer block for VarHandle initialization with proper field types
static void	main(String[] args)
private void	patchMethodAsDeprecatedRedirector(com.github.javaparser.ast.body.MethodDeclaration methodToPatch, String toMethodName, com.github.javaparser.ast.type.Type returnType, com.github.javaparser.ast.body.Parameter... parameters)	Given a method declaration node this method will replace it's code and signature with code to redirect all calls to it to the newMethodName.
private void	patchVarHandleAccessorMethods(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration n)	For each method accessor to a field, add in the calls necessary to VarHandle.
(package private) void	processSpecialNodeTypes(com.github.javaparser.ast.nodeTypes.NodeWithType<?,com.github.javaparser.ast.type.Type> node, String name)
(package private) String	varHandleFieldName(String fieldName)
void	visit(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration node, Void arg)
void	visit(com.github.javaparser.ast.body.ConstructorDeclaration n, Void arg)

Methods inherited from class org.jctools.queues.varhandle.JavaParsingVarHandleQueueGenerator

capitalise, classType, cleanupComments, createVarHandleStaticInitializer, declareVarHandle, fieldAssignment, getFieldClassType, isCommentPresent, isRefArray, isRefType, methodCallExpr, organiseImports, outputPackage, patchVarHandleAccessorMethod, queueClassNamePrefix, removeStaticFieldsAndInitialisers, replaceParentClassesForVarHandle, returnField, staticImportDeclaration, translateQueueName, varHandleCompareAndSet, varHandleGetVolatile, varHandleSetRelease, visit, visit, visit

Methods inherited from class com.github.javaparser.ast.visitor.VoidVisitorAdapter

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jctools.queues.util.JCToolsGenerator

visit

Constructor Details

JavaParsingVarHandleArrayQueueGenerator

public JavaParsingVarHandleArrayQueueGenerator(String sourceFileName)

Method Details

main

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

Throws:

Exception

processSpecialNodeTypes

void processSpecialNodeTypes(com.github.javaparser.ast.nodeTypes.NodeWithType<?,com.github.javaparser.ast.type.Type> node,
 String name)

Specified by:

processSpecialNodeTypes in class JavaParsingVarHandleQueueGenerator

visit

public void visit(com.github.javaparser.ast.body.ConstructorDeclaration n,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

visit

public void visit(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration node,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

varHandleFieldName

String varHandleFieldName(String fieldName)

Specified by:

varHandleFieldName in class JavaParsingVarHandleQueueGenerator

patchMethodAsDeprecatedRedirector

private void patchMethodAsDeprecatedRedirector(com.github.javaparser.ast.body.MethodDeclaration methodToPatch,
 String toMethodName,
 com.github.javaparser.ast.type.Type returnType,
 com.github.javaparser.ast.body.Parameter... parameters)

Given a method declaration node this method will replace it's code and signature with code to redirect all calls to it to the newMethodName. Method signatures of both methods must match exactly.

patchVarHandleAccessorMethods

private void patchVarHandleAccessorMethods(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration n)

For each method accessor to a field, add in the calls necessary to VarHandle. Only methods start with so/cas/sv/lv/lp followed by the field name are processed.

Parameters:

n - the AST node for the containing class

createVarHandleStaticInitializerWithTypes

private com.github.javaparser.ast.body.InitializerDeclaration createVarHandleStaticInitializerWithTypes(String className,
 List<JavaParsingVarHandleArrayQueueGenerator.FieldInfo> fieldInfos)

Creates a static initializer block for VarHandle initialization with proper field types