android-14.0.0_r21/s

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.metalava.apilevels;

import com.google.common.collect.Iterables;
import org.jetbrains.annotations.NotNull;

import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Represents a class or an interface and its methods/fields.
 * This is used to write the simplified XML file containing all the public API.
 */
public class ApiClass extends ApiElement {
    private final List<ApiElement> mSuperClasses = new ArrayList<>();
    private final List<ApiElement> mInterfaces = new ArrayList<>();
    private boolean mPackagePrivate = false;

    /**
     * If negative, never seen as public. The absolute value is the last api level it is seen as hidden in.
     * E.g. "-5" means a class that was hidden in api levels 1-5, then it was deleted, and "8"
     * means a class that was hidden in api levels 1-8 then made public in 9.
     */
    private int mPrivateUntil; // Package private class?

    private final Map<String, ApiElement> mFields = new ConcurrentHashMap<>();
    private final Map<String, ApiElement> mMethods = new ConcurrentHashMap<>();

    public ApiClass(String name, int version, boolean deprecated) {
        super(name, version, deprecated);
    }

    public ApiElement addField(String name, int version, boolean deprecated) {
        return addToMap(mFields, name, version, deprecated);
    }

    public ApiElement addMethod(String name, int version, boolean deprecated) {
        // Correct historical mistake in android.jar files
        if (name.endsWith(")Ljava/lang/AbstractStringBuilder;")) {
            name = name.substring(0, name.length() - ")Ljava/lang/AbstractStringBuilder;".length()) + ")L" + getName() + ";";
        }
        return addToMap(mMethods, name, version, deprecated);
    }

    public ApiElement addSuperClass(String superClass, int since) {
        return addToArray(mSuperClasses, superClass, since);
    }

    public ApiElement removeSuperClass(String superClass) {
        ApiElement entry = findByName(mSuperClasses, superClass);
        if (entry != null) {
            mSuperClasses.remove(entry);
        }
        return entry;
    }

    @NotNull
    List<ApiElement> getSuperClasses() {
        return mSuperClasses;
    }

    public void updateHidden(int api, boolean hidden) {
        if (hidden) {
            mPrivateUntil = -api;
        } else {
            mPrivateUntil = Math.abs(api);
        }
    }

    public boolean alwaysHidden() {
        return mPrivateUntil < 0;
    }

    public int getHiddenUntil() {
        return mPrivateUntil;
    }

    public void setHiddenUntil(int api) {
        mPrivateUntil = api;
    }

    public void addInterface(String interfaceClass, int since) {
        addToArray(mInterfaces, interfaceClass, since);
    }

    public List<ApiElement> getInterfaces() {
        return mInterfaces;
    }

    private ApiElement addToMap(Map<String, ApiElement> elements, String name, int version, boolean deprecated) {
        ApiElement element = elements.get(name);
        if (element == null) {
            element = new ApiElement(name, version, deprecated);
            elements.put(name, element);
        } else {
            element.update(version, deprecated);
        }
        return element;
    }

    private ApiElement addToArray(Collection<ApiElement> elements, String name, int version) {
        ApiElement element = findByName(elements, name);
        if (element == null) {
            element = new ApiElement(name, version);
            elements.add(element);
        } else {
            element.update(version);
        }
        return element;
    }

    private ApiElement findByName(Collection<ApiElement> collection, String name) {
        for (ApiElement element : collection) {
            if (element.getName().equals(name)) {
                return element;
            }
        }
        return null;
    }

    @Override
    public void print(String tag, ApiElement parentElement, String indent, PrintStream stream) {
        if (mPrivateUntil < 0) {
            return;
        }
        super.print(tag, false, parentElement, indent, stream);
        String innerIndent = indent + '\t';
        print(mSuperClasses, "extends", innerIndent, stream);
        print(mInterfaces, "implements", innerIndent, stream);
        print(mMethods.values(), "method", innerIndent, stream);
        print(mFields.values(), "field", innerIndent, stream);
        printClosingTag(tag, indent, stream);
    }

    /**
     * Removes all interfaces that are also implemented by superclasses or extended by interfaces
     * this class implements.
     *
     * @param allClasses all classes keyed by their names.
     */
    public void removeImplicitInterfaces(Map<String, ApiClass> allClasses) {
        if (mInterfaces.isEmpty() || mSuperClasses.isEmpty()) {
            return;
        }

        for (Iterator<ApiElement> iterator = mInterfaces.iterator(); iterator.hasNext(); ) {
            ApiElement interfaceElement = iterator.next();

            for (ApiElement superClass : mSuperClasses) {
                if (superClass.introducedNotLaterThan(interfaceElement)) {
                    ApiClass cls = allClasses.get(superClass.getName());
                    if (cls != null && cls.implementsInterface(interfaceElement, allClasses)) {
                        iterator.remove();
                        break;
                    }
                }
            }
        }
    }

    private boolean implementsInterface(ApiElement interfaceElement, Map<String, ApiClass> allClasses) {
        for (ApiElement localInterface : mInterfaces) {
            if (localInterface.introducedNotLaterThan(interfaceElement)) {
                if (interfaceElement.getName().equals(localInterface.getName())) {
                    return true;
                }
                // Check parent interface.
                ApiClass cls = allClasses.get(localInterface.getName());
                if (cls != null && cls.implementsInterface(interfaceElement, allClasses)) {
                    return true;
                }
            }
        }

        for (ApiElement superClass : mSuperClasses) {
            if (superClass.introducedNotLaterThan(interfaceElement)) {
                ApiClass cls = allClasses.get(superClass.getName());
                if (cls != null && cls.implementsInterface(interfaceElement, allClasses)) {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Removes all methods that override method declared by superclasses and interfaces of this class.
     *
     * @param allClasses all classes keyed by their names.
     */
    public void removeOverridingMethods(Map<String, ApiClass> allClasses) {
        for (Iterator<Map.Entry<String, ApiElement>> it = mMethods.entrySet().iterator(); it.hasNext(); ) {
            Map.Entry<String, ApiElement> entry = it.next();
            ApiElement method = entry.getValue();
            if (!method.getName().startsWith("<init>(") && isOverrideOfInherited(method, allClasses)) {
                it.remove();
            }
        }
    }

    /**
     * Checks if the given method overrides one of the methods defined by this class or
     * its superclasses or interfaces.
     *
     * @param method     the method to check
     * @param allClasses the map containing all API classes
     * @return true if the method is an override
     */
    private boolean isOverride(ApiElement method, Map<String, ApiClass> allClasses) {
        String name = method.getName();
        ApiElement localMethod = mMethods.get(name);
        if (localMethod != null && localMethod.introducedNotLaterThan(method)) {
            // This class has the method and it was introduced in at the same api level
            // as the child method, or before.
            return true;
        }
        return isOverrideOfInherited(method, allClasses);
    }

    /**
     * Checks if the given method overrides one of the methods declared by ancestors of this class.
     */
    private boolean isOverrideOfInherited(ApiElement method, Map<String, ApiClass> allClasses) {
        // Check this class' parents.
        for (ApiElement parent : Iterables.concat(mSuperClasses, mInterfaces)) {
            // Only check the parent if it was a parent class at the introduction of the method.
            if (parent.introducedNotLaterThan(method)) {
                ApiClass cls = allClasses.get(parent.getName());
                if (cls != null && cls.isOverride(method, allClasses)) {
                    return true;
                }
            }
        }

        return false;
    }

    @Override
    public String toString() {
        return getName();
    }

    private boolean haveInlined = false;

    public void inlineFromHiddenSuperClasses(Map<String, ApiClass> hidden) {
        if (haveInlined) {
            return;
        }
        haveInlined = true;
        for (ApiElement superClass : getSuperClasses()) {
            ApiClass hiddenSuper = hidden.get(superClass.getName());
            if (hiddenSuper != null) {
                hiddenSuper.inlineFromHiddenSuperClasses(hidden);
                Map<String, ApiElement> myMethods = this.mMethods;
                Map<String, ApiElement> myFields = this.mFields;
                for (Map.Entry<String, ApiElement> entry : hiddenSuper.mMethods.entrySet()) {
                    String name = entry.getKey();
                    ApiElement value = entry.getValue();
                    if (!myMethods.containsKey(name)) {
                        myMethods.put(name, value);
                    }
                }
                for (Map.Entry<String, ApiElement> entry : hiddenSuper.mFields.entrySet()) {
                    String name = entry.getKey();
                    ApiElement value = entry.getValue();
                    if (!myFields.containsKey(name)) {
                        myFields.put(name, value);
                    }
                }
            }
        }
    }

    public void removeHiddenSuperClasses(Map<String, ApiClass> api) {
        // If we've included a package private class in the super class map (from the older android.jar files)
        // remove these here and replace with the filtered super classes, updating API levels in the process
        ListIterator<ApiElement> iterator = mSuperClasses.listIterator();
        int min = Integer.MAX_VALUE;
        while (iterator.hasNext()) {
            ApiElement next = iterator.next();
            min = Math.min(min, next.getSince());
            ApiClass extendsClass = api.get(next.getName());
            if (extendsClass != null && extendsClass.alwaysHidden()) {
                int since = extendsClass.getSince();
                iterator.remove();
                for (ApiElement other : mSuperClasses) {
                    if (other.getSince() >= since) {
                        other.update(min);
                    }
                }
                break;
            }
        }
    }

    // Ensure this class doesn't extend/implement any other classes/interfaces that are
    // not in the provided api. This can happen when a class in an android.jar file
    // encodes the inheritance, but the class that is inherited is not present in any
    // android.jar file. The class would instead be present in an apex's stub jar file.
    // An example of this is the QosSessionAttributes interface being provided by the
    // Connectivity apex, but being implemented by NrQosSessionAttributes from
    // frameworks/base/telephony.
    public void removeMissingClasses(Map<String, ApiClass> api) {
        Iterator<ApiElement> superClassIter = mSuperClasses.iterator();
        while (superClassIter.hasNext()) {
            ApiElement scls = superClassIter.next();
            if (!api.containsKey(scls.getName())) {
                superClassIter.remove();
            }
        }

        Iterator<ApiElement> interfacesIter = mInterfaces.iterator();
        while (interfacesIter.hasNext()) {
            ApiElement intf = interfacesIter.next();
            if (!api.containsKey(intf.getName())) {
                interfacesIter.remove();
            }
        }
    }

    // Returns the set of superclasses or interfaces are not present in the provided api map
    public Set<ApiElement> findMissingClasses(Map<String, ApiClass> api) {
        Set<ApiElement> result = new HashSet<>();
        for (ApiElement scls : mSuperClasses) {
            if (!api.containsKey(scls.getName())) {
                result.add(scls);
            }
        }

        for (ApiElement intf : mInterfaces) {
            if (!api.containsKey(intf.getName())) {
                result.add(intf);
            }
        }
        return result;
    }

    public Iterator<ApiElement> getFieldIterator() {
        return mFields.values().iterator();
    }

    public Iterator<ApiElement> getMethodIterator() {
        return mMethods.values().iterator();
    }

    public ApiElement getField(String name) {
        return mFields.get(name);
    }

    public ApiElement getMethod(String name) {
        return mMethods.get(name);
    }
}