Use visitor for json creation of locations #170
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * 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") | ||
| 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); | ||
| } | ||
|
|
||
| /** | ||
| * Visits a location and returns a JSON object. | ||
| * | ||
| * @param location the location to visit | ||
| * @return a JSON object representing the location | ||
| */ | ||
| public JSONObject visit(Location location) { | ||
| return location.accept(this, null); | ||
| } | ||
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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. TheJSONObjectimplements raw type ofMapand every call toputis risky in view of javac. The only way to resolve this warning is to change the json dependency toorg.jsonfromcom.googlecode.json-simple:json-simplesince 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 withorg.jsonand can get rid of all@SuppressWarnings("unchecked").