Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some documentation to lang::java #1890

Merged
merged 6 commits into from
Dec 7, 2023
Merged

Added some documentation to lang::java #1890

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f9c3ce
Add some documentation to Java AST generators
Nov 20, 2023
06a2b96
Add some comments to Java M3 functions
Nov 20, 2023
6201540
Deprecate getMethodSignature
Nov 21, 2023
9159814
Fix #1889
Nov 21, 2023
006c815
Fix deprecated tags in Node (needs to be lowercase)
Nov 27, 2023
f47a44c
Update Core.rsc
jurgenvinju Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/org/rascalmpl/library/Node.rsc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ getKeywordParameters("f"(10, "abc", height=0));
@javaClass{org.rascalmpl.library.Prelude}
public java map[str,value] getKeywordParameters(node T);

@Deprecated{
@deprecated{
Use getKeywordParameters(T)
}
public map[str, value] getAnnotations(node T) = getKeywordParameters(T);
Expand All @@ -65,7 +65,7 @@ setKeywordParameters("f"(10, "abc"), ("height":0));
@javaClass{org.rascalmpl.library.Prelude}
public java &T <: node setKeywordParameters(&T <: node x, map[str,value] keywordParameters);

@Deprecated{
@deprecated{
Use setKeywordParameters(x, keywordParameters)
}
public &T <: node setAnnotations(&T <: node x, map[str,value] keywordParameters)
Expand Down Expand Up @@ -98,7 +98,7 @@ public java node makeNode(str N, value V..., map[str, value] keywordParameters =
@javaClass{org.rascalmpl.library.Prelude}
public java &T <: node unset(&T <: node x, str keywordParameter);

@Deprecated{
@deprecated{
Use unset(x, kw)
}
public &T <: node delAnnotation(&T <: node x, str keywordParameter) = unset(x, keywordParameter);
Expand All @@ -118,7 +118,7 @@ public &T <: node unset(&T <: node x, set[str] keywordParameters){
@javaClass{org.rascalmpl.library.Prelude}
public java &T <: node unset(&T <: node x);

@Deprecated{
@deprecated{
Use `unset(x)`
}
public &T <: node delAnnotations(&T <: node x) = unset(x);
Expand All @@ -128,7 +128,7 @@ public &T <: node delAnnotations(&T <: node x) = unset(x);
@javaClass{org.rascalmpl.library.Prelude}
public java &T unsetRec(&T x);

@Deprecated{
@deprecated{
Use `unsetRec(x)`
}
public &T delAnnotationsRec(&T x) = unsetRec(x);
Expand Down
70 changes: 41 additions & 29 deletions src/org/rascalmpl/library/lang/java/m3/AST.rsc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import util::Reflective;
import IO;
import String;
import List;

data Declaration
= \compilationUnit(list[Declaration] imports, list[Declaration] types)
| \compilationUnit(Declaration package, list[Declaration] imports, list[Declaration] types)
Expand Down Expand Up @@ -39,7 +39,7 @@ data Declaration
;


data Expression
data Expression
= \arrayAccess(Expression array, Expression index)
| \newArray(Type \type, list[Expression] dimensions, Expression init)
| \newArray(Type \type, list[Expression] dimensions)
Expand Down Expand Up @@ -76,11 +76,11 @@ data Expression
| \simpleName(str name)
| \markerAnnotation(str typeName)
| \normalAnnotation(str typeName, list[Expression] memberValuePairs)
| \memberValuePair(str name, Expression \value)
| \memberValuePair(str name, Expression \value)
| \singleMemberAnnotation(str typeName, Expression \value)
;
data Statement
;

data Statement
= \assert(Expression expression)
| \assert(Expression expression, Expression message)
| \block(list[Statement] statements)
Expand All @@ -104,16 +104,16 @@ data Statement
| \synchronizedStatement(Expression lock, Statement body)
| \throw(Expression expression)
| \try(Statement body, list[Statement] catchClauses)
| \try(Statement body, list[Statement] catchClauses, Statement \finally)
| \try(Statement body, list[Statement] catchClauses, Statement \finally)
| \catch(Declaration exception, Statement body)
| \declarationStatement(Declaration declaration)
| \while(Expression condition, Statement body)
| \expressionStatement(Expression stmt)
| \constructorCall(bool isSuper, Expression expr, list[Expression] arguments)
| \constructorCall(bool isSuper, list[Expression] arguments)
;
data Type
;

data Type
= arrayType(Type \type)
| parameterizedType(Type \type)
| qualifiedType(Type qualifier, Expression simpleName)
Expand All @@ -133,7 +133,7 @@ data Type
| \void()
| \boolean()
;

data Modifier
= \private()
| \public()
Expand All @@ -153,7 +153,7 @@ data Modifier
;

@memo
set[loc] getPaths(loc dir, str suffix) {
set[loc] getPaths(loc dir, str suffix) {
bool containsFile(loc d) = isDirectory(d) ? (x <- d.ls && x.extension == suffix) : false;
return find(dir, containsFile);
}
Expand All @@ -172,15 +172,15 @@ set[loc] findRoots(set[loc] folders) {
packagedepth = size(split(".", trim(p)));
roots += { d[path = intercalate("/", split("/", d.path)[..-packagedepth])] };
}
if (roots == {}) { // no package declaration means d is a root
roots += { d };

if (roots == {}) { // no package declaration means d is a root
roots += { d };
}
break;
} catch: ;

break;
} catch: ;
}

if (roots != {}) {
result += roots;
}
Expand All @@ -190,14 +190,14 @@ set[loc] findRoots(set[loc] folders) {
}
}
}

return result;
}


@synopsis{Creates AST from a file}
@description{

@synopsis{Creates AST from a single file.}
@description{
Wrapper around ((createAstsFromFiles)) to call it on a single file.
}
public Declaration createAstFromFile(loc file, bool collectBindings, bool errorRecovery = false, list[loc] sourcePath = [], list[loc] classPath = [], str javaVersion = "1.7") {
result = createAstsFromFiles({file}, collectBindings, errorRecovery = errorRecovery, sourcePath = sourcePath, classPath = classPath, javaVersion = javaVersion);
Expand All @@ -207,29 +207,42 @@ public Declaration createAstFromFile(loc file, bool collectBindings, bool errorR
throw "Unexpected number of ASTs returned from <file>";
}

@synopsis{Creates AST from a file using Eclipse JDT compiler}
@synopsis{Creates ASTs for a set of files using Eclipse JDT compiler.}
@pitfalls{
While the function takes a set of locations, it ignores the positional information of the location.
Meaning, that it analyzes the whole file and not just the part that the positional information describes.
}
@javaClass{org.rascalmpl.library.lang.java.m3.internal.EclipseJavaCompiler}
public java set[Declaration] createAstsFromFiles(set[loc] file, bool collectBindings, bool errorRecovery = false, list[loc] sourcePath = [], list[loc] classPath = [], str javaVersion = "1.7");

@synopsis{Creates AST from a string using Eclipse JDT compiler}
@synopsis{Creates AST from a string using Eclipse JDT compiler.}
@javaClass{org.rascalmpl.library.lang.java.m3.internal.EclipseJavaCompiler}
public java Declaration createAstFromString(loc fileName, str source, bool collectBinding, bool errorRecovery = false, list[loc] sourcePath = [], list[loc] classPath = [], str javaVersion = "1.7");

@synopsis{Creates a set ASTs for all Java source files in a project using Eclipse's JDT compiler}
@description{
The function recursively looks for the `.java` files in the directory.
The function also looks for the dependencies (`.jar` files) to include them.
Wraps around ((createAstsFromFiles)).
}
public set[Declaration] createAstsFromDirectory(loc project, bool collectBindings, bool errorRecovery = false, str javaVersion = "1.7" ) {
if (!(isDirectory(project))) {
throw "<project> is not a valid directory";
}

classPaths = [ j | j <- find(project, "jar"), isFile(j) ];
sourcePaths = getPaths(project, "java");
return createAstsFromFiles({ p | sp <- sourcePaths, p <- find(sp, "java"), isFile(p)}, collectBindings, sourcePath = [*findRoots(sourcePaths)], classPath = classPaths, errorRecovery = errorRecovery, javaVersion = javaVersion);
}

@synopsis{Creates a set ASTs for all Java source files in a Maven project using Eclipse's JDT compiler}
@synopsis{Creates a set of ASTs for all Java source files in a Maven project using Eclipse's JDT compiler.}
@description{
This function uses ((util::Reflective-getProjectPathConfig)), which inspects a `pom.xml` to
compute the dependencies and concrete locations of jar files that a Maven project depends on.
The location of `project` points to the root of the project to analyze. As a consequence, the `pom.xml`
is expected to be at `project + "pom.xml"`.

Wraps around ((createAstsFromFiles)).
}
public set[Declaration] createAstsFromMavenProject(loc project, bool collectBindings, bool errorRecovery = false, str javaVersion = "1.7" ) {
if (!exists(project + "pom.xml")) {
Expand All @@ -239,9 +252,8 @@ public set[Declaration] createAstsFromMavenProject(loc project, bool collectBind
if (!(isDirectory(project))) {
throw "<project> is not a valid directory";
}

classPaths = getProjectPathConfig(project).javaCompilerPath;
sourcePaths = getPaths(project, "java");
return createAstsFromFiles({ p | sp <- sourcePaths, p <- find(sp, "java"), isFile(p)}, collectBindings, sourcePath = [*findRoots(sourcePaths)], classPath = classPaths, errorRecovery = errorRecovery, javaVersion = javaVersion);
}

Loading
Loading