tiennm99/lombok
1
0
Fork 0
mirror of https://github.com/tiennm99/lombok.git synced 2026-08-20 02:28:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

More documentation.

Browse Source
This commit is contained in:
Reinier Zwitserloot
2009-07-05 22:01:51 +02:00
parent a9fe617303
commit 7dd061c263
7 changed files with 132 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
contrib/README
+4
View File
@@ -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.
deps/README
Vendored
+5
View File
@@ -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.
lib/README
+5
View File
@@ -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.
src_eclipseagent/java/lombok/eclipse/ClassLoaderWorkaround.java
+21
View File
@@ -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;
src_eclipseagent/lombok/eclipse/agent/EclipseCUDTransformer.java
+30 -1
View File
@@ -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 <code>org.eclipse.jdt.internal.compiler.ast CompilationUnitDeclaration</code> class,
* which is the top-level AST Node class for Eclipse.
*
* Transformations applied:<ul>
* <li>A field is added: 'public transient Object $lombokAST = null;'. We use it to cache our own AST object,
* usually of type <code>lombok.eclipse.EclipseAST.</code></li></ul>
*/
class EclipseCUDTransformer {
public byte[] transform(byte[] classfileBuffer) {
byte[] transform(byte[] classfileBuffer) {
ClassReader reader = new ClassReader(classfileBuffer);
ClassWriter writer = new ClassWriter(reader, 0);
src_eclipseagent/lombok/eclipse/agent/EclipseParserTransformer.java
+39 -2
View File
@@ -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 <code>org.eclipse.jdt.internal.compiler.parser.Parser</code> class,
* which handles all the actual java source to AST tree conversion in eclipse.
*
* Transformations applied:<ul>
* <li>The <code>CompilationUnitDeclaration endParse(int)</code> method is instrumented to call
* the lombok framework via ClassLoaderWorkaround to TransformEclipseAST with the CompilationUnitDeclaration
* right before it returns the CompilationUnitDeclaration.</li>
* <li>The <code>getMethodBodies(CompilationUnitDeclaration)</code> is similarly instrumented; eclipse uses a
* 2-step parsing system, where the bodies of methods aren't filled in until its actually neccessary. Lombok
* gets a chance to change the AST immediately after either step.</li>
* <li>The <code>parse(MethodDeclaration, CUD)</code>, <code>parse(ConstructorDeclaration, CUD)</code> and
* <code>parse(Initializer, TypeDeclaration, CUD)</code> methods could all be theoretically called to
* flesh out just one part of a half-finished AST tree. These methods are all instrumented to call Lombok
* with the CUD before returning it to whomever wanted it filled out.</li>
*/
class EclipseParserTransformer {
private static final String COMPILER_PKG =
"Lorg/eclipse/jdt/internal/compiler/ast/";
@@ -34,7 +71,7 @@ class EclipseParserTransformer {
rewriters = Collections.unmodifiableMap(map);
}
public byte[] transform(byte[] classfileBuffer) {
byte[] transform(byte[] classfileBuffer) {
ClassReader reader = new ClassReader(classfileBuffer);
ClassWriter writer = new ClassWriter(reader, 0);
@@ -43,7 +80,7 @@ class EclipseParserTransformer {
return writer.toByteArray();
}
public static RuntimeException sneakyThrow(Throwable t) {
static RuntimeException sneakyThrow(Throwable t) {
if ( t == null ) throw new NullPointerException("t");
EclipseParserTransformer.<RuntimeException>sneakyThrow0(t);
return null;
src_eclipseagent/lombok/eclipse/agent/EclipsePatcher.java
+28 -2
View File
@@ -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.io.File;
@@ -16,6 +37,13 @@ import java.util.jar.JarFile;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* This is a java-agent that patches some of eclipse's classes so AST Nodes are handed off to Lombok
* for modification before Eclipse actually uses them to compile, render errors, show code outlines,
* create auto-completion dialogs, and anything else eclipse does with java code. See the *Transformer
* classes in this package for more information about which classes are transformed and how they are
* transformed.
*/
public class EclipsePatcher {
private EclipsePatcher() {}
@@ -68,8 +96,6 @@ public class EclipsePatcher {
private static void addLombokToSearchPaths(Instrumentation instrumentation) throws Exception {
String path = findPathOfOurClassloader();
//On java 1.5, you don't have these methods, so you'll be forced to manually -Xbootclasspath/a them in.
// instrumentation.appendToSystemClassLoaderSearch(new JarFile(path + "/lombok.jar"));
// instrumentation.appendToBootstrapClassLoaderSearch(new JarFile(path + "/lombok.eclipse.agent.jar"));
tryCallMethod(instrumentation, "appendToSystemClassLoaderSearch", path + "/lombok.jar");
tryCallMethod(instrumentation, "appendToBootstrapClassLoaderSearch", path + "/lombok.eclipse.agent.jar");
}