Jump to: navigation, search

Difference between revisions of "JDT Core Programmer Guide"

(Overview)
(added x-ref to the committer faq)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Overview =
+
{{:DocumentationGuidelines/DraftHeader}}
[http://help.eclipse.org/indigo/index.jsp?nav=/3 JDT Core] in Eclipse Help.
+
 
 +
= Overview =
 +
 
 +
The purpose of this document is give insight into JDT Core internals.
 +
 
 +
If you're looking for information on '''JDT APIs''' you should start by visiting the [http://help.eclipse.org/indigo/index.jsp?nav=/3 JDT Core] section in Eclipse Help. You can also check [https://github.com/aupsy/org.eclipsecon2012.misc.tutorial/blob/master/Slides/How%20To%20Train%20the%20JDT%20Dragon%20combined.ppt How to Train the JDT Dragon] presentation by Ayushman Jain and Stephan Herrmann. Instructions for the tutorial can be found [https://github.com/aupsy/org.eclipsecon2012.misc.tutorial/tree/master/Handouts here].
 +
 
 +
Many issues of '''working with JDT/Core source code''' are covered in the [[JDT_Core_Committer_FAQ]], specifically:
 +
* The [[JDT_Core_Committer_FAQ#Coding|Coding]] section covers getting the code from git and getting it to compile in your workspace
 +
 
 +
If the answer to your question is neither there nor here, [http://wiki.eclipse.org/JDT/FAQ#If_your_question_is_not_answered_above ask the question].
 +
 
 +
= Concepts =
 
== Java Model ==
 
== Java Model ==
 
Java model is a lightweight model for views.
 
Java model is a lightweight model for views.
Line 6: Line 18:
 
Indexes of declarations, references and type hierarchy relationships.
 
Indexes of declarations, references and type hierarchy relationships.
  
Searching steps:
+
=== Searching steps ===
 +
# [[#Indexing]] phase
 
# Get the file names from indexes
 
# Get the file names from indexes
 +
# Validate the scope
 
# Parse the file and find out matching nodes
 
# Parse the file and find out matching nodes
# Resolve types and narrow down matches reported from index
+
# Resolve types (see [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.core/compiler/org/eclipse/jdt/internal/compiler/ast/CompilationUnitDeclaration.java#n528 CompilationUnitDeclaration#resolve()]) and narrow down matches reported from index
# Create the appropriate model element
+
# Create the appropriate model element and call the requestor
 +
 
 +
=== Indexing ===
 +
 
 +
* Stored in files in workspace/.metadata/org.eclipse.jdt.core
 +
* Separate index file for each class path entry (shared across projects)
 +
* Dedicated daemon thread
 +
* Names of declaration and references of JavaElements used in the file are stored in the index
 +
* First stored in Memory and then goes into the Disk
 +
** In Memory “fileName->category->names”
 +
** In Disk “Category->names->fileName”
 +
* For jars, .class files are read (even if source is available)
 +
* References are read from the constant pool
 +
 
 +
=== Precise and non-precise matches ===
 +
 
 +
If there is a search result for the given pattern, but a problem (e.g. errors in code, incomplete class path) occurred, the match is considered as [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchMatch.java#n47 inaccurate].
 +
 
 +
Inaccurate matches used to be called [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchResultCollector.java#n60 potential] matches and as such can still be seen in the [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.core.tests.model/src/org/eclipse/jdt/core/tests/model/JavaSearchBugsTests2.java tests] and tracing messages.
  
 
=== Using the APIs, an example ===
 
=== Using the APIs, an example ===
Line 47: Line 79:
 
== AST ==
 
== AST ==
 
Precise, fully resolved compiler parse tree.
 
Precise, fully resolved compiler parse tree.
 +
 +
= Tests =
 +
 +
== Unit tests ==
 +
 +
To run unit tests follow the instructions under [[JDT_Core_Committer_FAQ#Unit_Testing]].
 +
 +
New Java Search tests should be added to [http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/tree/org.eclipse.jdt.core.tests.model/src/org/eclipse/jdt/core/tests/model/JavaSearchBugsTests2.java JavaSearchBugsTests2].
 +
 +
== Performance tests ==
 +
 +
To run performance tests you need to have the following projects in your workspace:
 +
 +
*org.eclipse.jdt.core.tests.performance
 +
*org.eclipse.jdt.core.tests.binaries
 +
*org.eclipse.test.performance
 +
*org.eclipse.test.performance.win32 (if you're on Windows)
 +
 +
More info about obtaining the JDT/Core source code can be found here: [[JDT_Core_Committer_FAQ#Where_is_the_JDT.2FCore_code.3F]].
 +
 +
Useful VM arguments:
 +
*-Dmeasures=1 to reduce number of measurements to 1, default is 10
 +
*-Dprint=true to print more test details on the console
 +
*-Ddebug=true to print debug info on the console
  
 
[[Category:JDT]]
 
[[Category:JDT]]

Latest revision as of 09:30, 1 May 2013

Warning2.png
Draft Content
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.


Overview

The purpose of this document is give insight into JDT Core internals.

If you're looking for information on JDT APIs you should start by visiting the JDT Core section in Eclipse Help. You can also check How to Train the JDT Dragon presentation by Ayushman Jain and Stephan Herrmann. Instructions for the tutorial can be found here.

Many issues of working with JDT/Core source code are covered in the JDT_Core_Committer_FAQ, specifically:

  • The Coding section covers getting the code from git and getting it to compile in your workspace

If the answer to your question is neither there nor here, ask the question.

Concepts

Java Model

Java model is a lightweight model for views.

Search Engine

Indexes of declarations, references and type hierarchy relationships.

Searching steps

  1. #Indexing phase
  2. Get the file names from indexes
  3. Validate the scope
  4. Parse the file and find out matching nodes
  5. Resolve types (see CompilationUnitDeclaration#resolve()) and narrow down matches reported from index
  6. Create the appropriate model element and call the requestor

Indexing

  • Stored in files in workspace/.metadata/org.eclipse.jdt.core
  • Separate index file for each class path entry (shared across projects)
  • Dedicated daemon thread
  • Names of declaration and references of JavaElements used in the file are stored in the index
  • First stored in Memory and then goes into the Disk
    • In Memory “fileName->category->names”
    • In Disk “Category->names->fileName”
  • For jars, .class files are read (even if source is available)
  • References are read from the constant pool

Precise and non-precise matches

If there is a search result for the given pattern, but a problem (e.g. errors in code, incomplete class path) occurred, the match is considered as inaccurate.

Inaccurate matches used to be called potential matches and as such can still be seen in the tests and tracing messages.

Using the APIs, an example

Create a search pattern:

SearchPattern pattern = SearchPattern.createPattern(
 "foo(*) int", 
 IJavaSearchConstants.METHOD, 
 IJavaSearchConstants.DECLARATIONS, 
 SearchPattern.R_PATTERN_MATCH
);

Create a search scope:

IJavaSearchScope scope = SearchEngine.createWorkspaceScope();

Collect results using SearchRequestor subclass:

SearchRequestor requestor = new SearchRequestor() {
 public void acceptSearchMatch(SearchMatch match) {
   System.out.println(match.getElement());
 }
};

Start search:

new SearchEngine().search(
 pattern, 
 new SearchParticipant[] { SearchEngine.getDefaultSearchParticipant()}, 
 scope, 
 requestor, 
 null /*progress monitor*/
);

AST

Precise, fully resolved compiler parse tree.

Tests

Unit tests

To run unit tests follow the instructions under JDT_Core_Committer_FAQ#Unit_Testing.

New Java Search tests should be added to JavaSearchBugsTests2.

Performance tests

To run performance tests you need to have the following projects in your workspace:

  • org.eclipse.jdt.core.tests.performance
  • org.eclipse.jdt.core.tests.binaries
  • org.eclipse.test.performance
  • org.eclipse.test.performance.win32 (if you're on Windows)

More info about obtaining the JDT/Core source code can be found here: JDT_Core_Committer_FAQ#Where_is_the_JDT.2FCore_code.3F.

Useful VM arguments:

  • -Dmeasures=1 to reduce number of measurements to 1, default is 10
  • -Dprint=true to print more test details on the console
  • -Ddebug=true to print debug info on the console