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.

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

Use visitor for json creation of locations #170

Merged
merged 13 commits into from
Apr 19, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import com.github.javaparser.ast.nodeTypes.NodeWithRange;
import edu.ucr.cs.riple.injector.Helper;
import edu.ucr.cs.riple.injector.location.Location;
import edu.ucr.cs.riple.injector.location.LocationToJsonVisitor;
import edu.ucr.cs.riple.injector.modifications.Modification;
import java.util.Objects;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -89,7 +90,7 @@ public int hashCode() {
@SuppressWarnings("unchecked")
public JSONObject getJson() {
JSONObject res = new JSONObject();
res.put("LOCATION", location.getJson());
res.put("LOCATION", location.accept(new LocationToJsonVisitor(), null));
res.put("ANNOTATION", annotation);
return res;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
import java.util.Objects;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import org.json.simple.JSONObject;

/** Represents a location of an element in the source code. */
public abstract class Location {
Expand All @@ -50,16 +49,6 @@ public abstract class Location {
/** The path to the file containing the element. */
public Path path;

/** The Keys used to represent a location in JSON format */
public enum KEYS {
VARIABLES,
METHOD,
KIND,
CLASS,
PATH,
INDEX
}

/**
* Creates an instance of {@link Location} for a given type, path and class. This constructor is a
* base class for all subclasses and must provide these values upon instantiation.
Expand Down Expand Up @@ -126,13 +115,6 @@ public static Location createLocationFromArrayInfo(String[] values) {
protected abstract Modification applyToMember(
NodeList<BodyDeclaration<?>> members, Change change);

/**
* Fills the given JSON object with the information of this location.
*
* @param res The JSON object to be filled.
*/
protected abstract void fillJsonInformation(JSONObject res);

/**
* Applies the change to the target element on the given compilation unit tree.
*
Expand All @@ -152,16 +134,6 @@ public Modification apply(CompilationUnit tree, Change change) {
return applyToMember(clazz, change);
}

@SuppressWarnings("unchecked")
public JSONObject getJson() {
JSONObject res = new JSONObject();
res.put(KEYS.CLASS, clazz);
res.put(KEYS.KIND, type.toString());
res.put(KEYS.PATH, path);
fillJsonInformation(res);
return res;
}

/**
* If this location is of kind {@link LocationKind#METHOD}, calls the consumer on the location.
*
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/*
* MIT License
*
* Copyright (c) 2023 Nima Karimipour
*
* 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 edu.ucr.cs.riple.injector.location;

import org.json.simple.JSONArray;
import org.json.simple.JSONObject;

/** A visitor that converts a location to a JSON object. */
public class LocationToJsonVisitor implements LocationVisitor<JSONObject, Void> {

/** The Keys used to represent a location in JSON format */
public enum KEYS {
VARIABLES,
METHOD,
KIND,
CLASS,
PATH,
INDEX
}

@SuppressWarnings("unchecked")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need these unchecked suppressions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is required for putting object of any type in JSON. The JSONObject implements raw type of Map and every call to put is risky in view of javac. The only way to resolve this warning is to change the json dependency to org.json from com.googlecode.json-simple:json-simple since it is compiled with a very old javac (the latest release is for 2012). We have an open PR that is not landed yet as it has a low priority #123 that replaces the dependency with org.json and can get rid of all @SuppressWarnings("unchecked").

private JSONObject defaultAction(Location location) {
JSONObject res = new JSONObject();
res.put(KEYS.CLASS, location.clazz);
res.put(KEYS.KIND, location.type.toString());
res.put(KEYS.PATH, location.path);
return res;
}

@SuppressWarnings("unchecked")
@Override
public JSONObject visitMethod(OnMethod onMethod, Void unused) {
JSONObject res = defaultAction(onMethod);
res.put(KEYS.METHOD, onMethod.method);
return res;
}

@SuppressWarnings("unchecked")
@Override
public JSONObject visitField(OnField onField, Void unused) {
JSONObject res = defaultAction(onField);
JSONArray fields = new JSONArray();
fields.addAll(onField.variables);
res.put(KEYS.VARIABLES, fields);
return res;
}

@SuppressWarnings("unchecked")
@Override
public JSONObject visitParameter(OnParameter onParameter, Void unused) {
JSONObject res = defaultAction(onParameter);
res.put(KEYS.METHOD, onParameter.method);
res.put(KEYS.INDEX, onParameter.index);
return res;
}

@Override
public JSONObject visitClass(OnClass onClass, Void unused) {
return defaultAction(onClass);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
import java.util.Optional;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.json.simple.JSONObject;

/** Represents a location for class element. This location is used to apply changes to a class. */
public class OnClass extends Location {
Expand Down Expand Up @@ -76,11 +75,6 @@ public static boolean isAnonymousClassFlatName(String flatName) {
return anonymousClassPattern.matcher(flatName).matches();
}

@Override
protected void fillJsonInformation(JSONObject res) {
// no op
}

@Override
public <R, P> R accept(LocationVisitor<R, P> v, P p) {
return v.visitClass(this, p);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;

/**
* Represents a location for field element. This location is used to apply changes to a class field.
Expand Down Expand Up @@ -68,14 +66,6 @@ public OnField(String path, String clazz, Set<String> variables) {
this(Helper.deserializePath(path), clazz, variables);
}

@SuppressWarnings("unchecked")
@Override
protected void fillJsonInformation(JSONObject res) {
JSONArray fields = new JSONArray();
fields.addAll(variables);
res.put(KEYS.VARIABLES, fields);
}

@Override
@Nullable
protected Modification applyToMember(NodeList<BodyDeclaration<?>> members, Change change) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import org.json.simple.JSONObject;

/** Represents a location for method element. This location is used to apply changes to a method. */
public class OnMethod extends Location {
Expand All @@ -58,12 +57,6 @@ public OnMethod(String path, String clazz, String method) {
this(Helper.deserializePath(path), clazz, method);
}

@SuppressWarnings("unchecked")
@Override
protected void fillJsonInformation(JSONObject res) {
res.put(KEYS.METHOD, method);
}

@Override
@Nullable
protected Modification applyToMember(NodeList<BodyDeclaration<?>> members, Change change) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import org.json.simple.JSONObject;

/**
* Represents a location for parameter element. This location is used to apply changes to a
Expand Down Expand Up @@ -66,13 +65,6 @@ public OnParameter(String path, String clazz, String method, int index) {
this(Helper.deserializePath(path), clazz, method, index);
}

@SuppressWarnings("unchecked")
@Override
protected void fillJsonInformation(JSONObject res) {
res.put(KEYS.METHOD, method);
res.put(KEYS.INDEX, index);
}

@Override
@Nullable
protected Modification applyToMember(NodeList<BodyDeclaration<?>> members, Change change) {
Expand Down