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

AnalysisScope example #11

Merged
merged 9 commits into from
Nov 30, 2024
Merged

AnalysisScope example #11

merged 9 commits into from
Nov 30, 2024

Conversation

jerryxu158
Copy link
Contributor

No description provided.

@msridhar msridhar changed the title Anaylsis scope AnalysisScope example Oct 24, 2021
Copy link
Member

@msridhar msridhar left a comment

Choose a reason for hiding this comment

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

Few more comments

//for more information, please check out https://github.com/wala/WALA/wiki/Analysis-Scope


public class analysisscope {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
public class analysisscope {
public class AnalysisScopeExamples {

Class names start with a capital and use camel case. See https://google.github.io/styleguide/javaguide.html#s5.2.2-class-names

public class analysisscope {
/**
* @param classPath paths of jars to include in analysis scope, formatted as a Java classpath
* @return AnaylsisScope object created by makeJavaBinaryAnalysisScope
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* @return AnaylsisScope object created by makeJavaBinaryAnalysisScope
* @return AnalysisScope object created by makeJavaBinaryAnalysisScope

* @return return an analysis scope object
* @throws IOException
*/
AnalysisScope makeAnalysisScope(String classPath, String exceptionFile) throws IOException{
Copy link
Member

Choose a reason for hiding this comment

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

The first parameter should be named something like scopeFilePath, and the second should be exclusionsFilePath

*/
AnalysisScope makeAnalysisScope(String classPath, String exceptionFile) throws IOException{
File exception = new File(exceptionFile);
return AnalysisScopeReader.readJavaScope(classPath, exception, null);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
return AnalysisScopeReader.readJavaScope(classPath, exception, null);
return AnalysisScopeReader.readJavaScope(classPath, exception, AnalysisScopeExamples.class.getClassLoader());

Should pass a real classloader as the final parameter.

import java.io.IOException;
import com.ibm.wala.util.config.AnalysisScopeReader;

//for more information, please check out https://github.com/wala/WALA/wiki/Analysis-Scope
Copy link
Member

Choose a reason for hiding this comment

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

Write this as proper Javadoc on the class rather than just a single line comment

/**
*
* @param scopeFilePath Location of a scope file in string form
* @param exceptionFilePath location of an exception file
Copy link
Member

Choose a reason for hiding this comment

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

Everywhere you write exception it should be exclusion. These files give a pattern of which Java packages to exclude from the scope

@msridhar msridhar enabled auto-merge (squash) November 30, 2024 18:34
@msridhar msridhar merged commit cd28a39 into wala:master Nov 30, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants