From 7dd061c263803dadefe244bcc78a67f4d12bd42e Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Sun, 5 Jul 2009 22:01:51 +0200 Subject: More documentation. --- contrib/README | 4 +++ deps/README | 5 +++ lib/README | 5 +++ .../java/lombok/eclipse/ClassLoaderWorkaround.java | 21 +++++++++++ .../eclipse/agent/EclipseCUDTransformer.java | 31 +++++++++++++++- .../eclipse/agent/EclipseParserTransformer.java | 41 ++++++++++++++++++++-- .../lombok/eclipse/agent/EclipsePatcher.java | 30 ++++++++++++++-- 7 files changed, 132 insertions(+), 5 deletions(-) create mode 100644 contrib/README create mode 100644 deps/README create mode 100644 lib/README diff --git a/contrib/README b/contrib/README new file mode 100644 index 00000000..b94d973f --- /dev/null +++ b/contrib/README @@ -0,0 +1,4 @@ +The files in this directory are not required to either run or build lombok. +They are in the repository solely because they are useful when developing lombok. +For example, the sources to used libraries are here so you can click through to it +in your IDE when you configure your library requirements correctly. diff --git a/deps/README b/deps/README new file mode 100644 index 00000000..cda42040 --- /dev/null +++ b/deps/README @@ -0,0 +1,5 @@ +'deps' are defined as those things which are required to compile or develop lombok, but which aren't required when +actually running lombok. The main lombok code is dependent on all libraries in the 'lombok' directory, whilst the agents +are dependent on both the contents of the 'agent' directory and the agent's specific directory (e.g. 'eclipse.agent'). + +For dependencies which need to be available at runtime, see the 'lib' directory. diff --git a/lib/README b/lib/README new file mode 100644 index 00000000..1e605c10 --- /dev/null +++ b/lib/README @@ -0,0 +1,5 @@ +'lib' is defined as those things which are required when actually running lombok. +The main lombok code requires all libraries in the 'lombok' directory, whilst the agents +require the contents of both the 'agent' directory and the agent's specific directory (e.g. 'eclipse.agent'). + +For dependencies which are required only at compile time, see the 'deps' directory. diff --git a/src_eclipseagent/java/lombok/eclipse/ClassLoaderWorkaround.java b/src_eclipseagent/java/lombok/eclipse/ClassLoaderWorkaround.java index bea5f917..f804ef1d 100644 --- a/src_eclipseagent/java/lombok/eclipse/ClassLoaderWorkaround.java +++ b/src_eclipseagent/java/lombok/eclipse/ClassLoaderWorkaround.java @@ -1,3 +1,24 @@ +/* + * Copyright © 2009 Reinier Zwitserloot and Roel Spilker. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ package java.lombok.eclipse; import java.io.ByteArrayOutputStream; diff --git a/src_eclipseagent/lombok/eclipse/agent/EclipseCUDTransformer.java b/src_eclipseagent/lombok/eclipse/agent/EclipseCUDTransformer.java index b1dc85cc..95689773 100644 --- a/src_eclipseagent/lombok/eclipse/agent/EclipseCUDTransformer.java +++ b/src_eclipseagent/lombok/eclipse/agent/EclipseCUDTransformer.java @@ -1,3 +1,24 @@ +/* + * Copyright © 2009 Reinier Zwitserloot and Roel Spilker. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ package lombok.eclipse.agent; import org.objectweb.asm.ClassAdapter; @@ -7,8 +28,16 @@ import org.objectweb.asm.ClassWriter; import org.objectweb.asm.FieldVisitor; import org.objectweb.asm.Opcodes; +/** + * Transforms Eclipse's org.eclipse.jdt.internal.compiler.ast CompilationUnitDeclaration class, + * which is the top-level AST Node class for Eclipse. + * + * Transformations applied: + */ class EclipseCUDTransformer { - public byte[] transform(byte[] classfileBuffer) { + byte[] transform(byte[] classfileBuffer) { ClassReader reader = new ClassReader(classfileBuffer); ClassWriter writer = new ClassWriter(reader, 0); diff --git a/src_eclipseagent/lombok/eclipse/agent/EclipseParserTransformer.java b/src_eclipseagent/lombok/eclipse/agent/EclipseParserTransformer.java index dac35445..66f515bf 100644 --- a/src_eclipseagent/lombok/eclipse/agent/EclipseParserTransformer.java +++ b/src_eclipseagent/lombok/eclipse/agent/EclipseParserTransformer.java @@ -1,3 +1,24 @@ +/* + * Copyright © 2009 Reinier Zwitserloot and Roel Spilker. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ package lombok.eclipse.agent; import java.lang.reflect.Constructor; @@ -15,6 +36,22 @@ import org.objectweb.asm.MethodAdapter; import org.objectweb.asm.MethodVisitor; import org.objectweb.asm.Opcodes; +/** + * Transforms Eclipse's org.eclipse.jdt.internal.compiler.parser.Parser class, + * which handles all the actual java source to AST tree conversion in eclipse. + * + * Transformations applied: