com.android.tools.lint.detector.api.Detector Java Examples

/**
 * Requests another pass through the data for the given detector. This is
 * typically done when a detector needs to do more expensive computation,
 * but it only wants to do this once it <b>knows</b> that an error is
 * present, or once it knows more specifically what to check for.
 *
 * @param detector the detector that should be included in the next pass.
 *            Note that the lint runner may refuse to run more than a couple
 *            of runs.
 * @param scope the scope to be revisited. This must be a subset of the
 *       current scope ({@link #getScope()}, and it is just a performance hint;
 *       in particular, the detector should be prepared to be called on other
 *       scopes as well (since they may have been requested by other detectors).
 *       You can pall null to indicate "all".
 */
public void requestRepeat(@NonNull Detector detector, @Nullable EnumSet<Scope> scope) {
    if (mRepeatingDetectors == null) {
        mRepeatingDetectors = new ArrayList<Detector>();
    }
    mRepeatingDetectors.add(detector);

    if (scope != null) {
        if (mRepeatScope == null) {
            mRepeatScope = scope;
        } else {
            mRepeatScope = EnumSet.copyOf(mRepeatScope);
            mRepeatScope.addAll(scope);
        }
    } else {
        mRepeatScope = Scope.ALL;
    }
}
 

@Nullable
private static List<Detector> union(
        @Nullable List<Detector> list1,
        @Nullable List<Detector> list2) {
    if (list1 == null) {
        return list2;
    } else if (list2 == null) {
        return list1;
    } else {
        // Use set to pick out unique detectors, since it's possible for there to be overlap,
        // e.g. the DuplicateIdDetector registers both a cross-resource issue and a
        // single-file issue, so it shows up on both scope lists:
        Set<Detector> set = new HashSet<Detector>(list1.size() + list2.size());
        set.addAll(list1);
        set.addAll(list2);

        return new ArrayList<Detector>(set);
    }
}
 

protected final Detector getDetectorInstance() {
    if (mDetector == null) {
        mDetector = getDetector();
    }

    return mDetector;
}
 

private void checkResFolder(
        @NonNull Project project,
        @Nullable Project main,
        @NonNull File res,
        @NonNull List<ResourceXmlDetector> xmlChecks,
        @Nullable List<Detector> dirChecks,
        @Nullable List<Detector> binaryChecks) {
    File[] resourceDirs = res.listFiles();
    if (resourceDirs == null) {
        return;
    }

    // Sort alphabetically such that we can process related folder types at the
    // same time, and to have a defined behavior such that detectors can rely on
    // predictable ordering, e.g. layouts are seen before menus are seen before
    // values, etc (l < m < v).

    Arrays.sort(resourceDirs);
    for (File dir : resourceDirs) {
        ResourceFolderType type = ResourceFolderType.getFolderType(dir.getName());
        if (type != null) {
            checkResourceFolder(project, main, dir, type, xmlChecks, dirChecks, binaryChecks);
        }

        if (mCanceled) {
            return;
        }
    }
}
 

private void checkJava(
        @NonNull Project project,
        @Nullable Project main,
        @NonNull List<File> sourceFolders,
        @NonNull List<Detector> checks) {
    JavaParser javaParser = mClient.getJavaParser(project);
    if (javaParser == null) {
        mClient.log(null, "No java parser provided to lint: not running Java checks");
        return;
    }

    assert !checks.isEmpty();

    // Gather all Java source files in a single pass; more efficient.
    List<File> sources = new ArrayList<File>(100);
    for (File folder : sourceFolders) {
        gatherJavaFiles(folder, sources);
    }
    if (!sources.isEmpty()) {
        JavaVisitor visitor = new JavaVisitor(javaParser, checks);
        List<JavaContext> contexts = Lists.newArrayListWithExpectedSize(sources.size());
        for (File file : sources) {
            JavaContext context = new JavaContext(this, project, main, file, javaParser);
            contexts.add(context);
        }

        visitor.prepare(contexts);
        for (JavaContext context : contexts) {
            fireEvent(EventType.SCANNING_FILE, context);
            visitor.visitFile(context);
            if (mCanceled) {
                return;
            }
        }
        visitor.dispose();
    }
}
 

private void checkPropertyFile(Project project, Project main, List<Detector> detectors,
        String relativePath) {
    File file = new File(project.getDir(), relativePath);
    if (file.exists()) {
        Context context = new Context(this, project, main, file);
        fireEvent(EventType.SCANNING_FILE, context);
        for (Detector detector : detectors) {
            if (detector.appliesTo(context, file)) {
                detector.beforeCheckFile(context);
                detector.run(context);
                detector.afterCheckFile(context);
            }
        }
    }
}
 

private void checkProperties(Project project, Project main) {
    List<Detector> detectors = mScopeDetectors.get(Scope.PROPERTY_FILE);
    if (detectors != null) {
        checkPropertyFile(project, main, detectors, FN_LOCAL_PROPERTIES);
        checkPropertyFile(project, main, detectors, FD_GRADLE_WRAPPER + separator +
                FN_GRADLE_WRAPPER_PROPERTIES);
    }
}
 

private void computeDetectors(@NonNull Project project) {
    // Ensure that the current visitor is recomputed
    mCurrentFolderType = null;
    mCurrentVisitor = null;

    Configuration configuration = project.getConfiguration(this);
    mScopeDetectors = new EnumMap<Scope, List<Detector>>(Scope.class);
    mApplicableDetectors = mRegistry.createDetectors(mClient, configuration,
            mScope, mScopeDetectors);

    validateScopeList();
}
 

@Override
protected Detector getDetector() {
    return new RelativeOverlapDetector();
}
 

@Override
protected Detector getDetector() {
    // Sample issue to check by the main driver
    return new AccessibilityDetector();
}
 

@Override
protected Detector getDetector() {
    return new ParcelDetector();
}
 

@Override
protected Detector getDetector() {
    return new SharedPrefsDetector();
}
 

@Override
protected Detector getDetector() {
    return new AddJavascriptInterfaceDetector();
}
 

@Override
protected Detector getDetector() {
    return new UselessViewDetector();
}
 

@Override
protected Detector getDetector() {
    return new ArraySizeDetector();
}
 

@Override
protected Detector getDetector() {
    return new SystemPermissionsDetector();
}
 

@Override
protected Detector getDetector() {
    return new DetectMissingPrefix();
}
 

@Override protected Detector getDetector() {
  return new InjectedFieldInJobNotTransientDetector();
}
 

@Override
protected Detector getDetector() {
    return new GroovyGradleDetector();
}
 

@Override
protected Detector getDetector() {
    return new CleanupDetector();
}
 

@Override
protected Detector getDetector() {
    return new SecurityDetector();
}
 

@Override
protected Detector getDetector() {
    return new SdCardDetector();
}
 

@Override
protected Detector getDetector() {
    return new OverrideDetector();
}
 

@Override
protected Detector getDetector() {
    return new PreferenceActivityDetector();
}
 

@Override
protected Detector getDetector() {
    return new HardcodedDebugModeDetector();
}
 

@Override
protected Detector getDetector() {
    return new HandlerDetector();
}
 

@Override
protected Detector getDetector() {
    fail("This is not used in the TypoLookupTest");
    return null;
}
 

@Override
protected Detector getDetector() {
    return new ManifestTypoDetector();
}
 

@Override
protected Detector getDetector() {
    return new PrivateKeyDetector();
}
 

@Override
protected Detector getDetector() {
    return new WrongLocationDetector();
}