framework.src.org.checkerframework.qualframework.poly.format.PrettyQualParamsFormatter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation
The Checker Framework enhances Java’s type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.
There is a newer version: 3.42.0
Show newest version
package org.checkerframework.qualframework.poly.format;

import org.checkerframework.javacutil.ErrorReporter;
import org.checkerframework.qualframework.poly.PolyQual;
import org.checkerframework.qualframework.poly.PolyQual.Combined;
import org.checkerframework.qualframework.poly.PolyQual.GroundQual;
import org.checkerframework.qualframework.poly.PolyQual.QualVar;
import org.checkerframework.qualframework.poly.QualParams;
import org.checkerframework.qualframework.poly.Wildcard;

import java.util.ArrayList;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;

/**
 * Formats a {@link QualParams} into the double chevron 《Q》 output format.
 */
public class PrettyQualParamsFormatter implements QualParamsFormatter {

    private final Set invisibleQualifiers;

    public PrettyQualParamsFormatter(Set invisibleQualifiers) {
        this.invisibleQualifiers = invisibleQualifiers;
    }

    @Override
    public String format(QualParams params) {
        return format(params, true, true);
    }

    @Override
    public String format(QualParams params, boolean printInvisible) {
        return format(params, true, printInvisible);
    }

    @Override
    public String format(QualParams params, boolean printPrimary, boolean printInvisible) {

        StringBuilder sb = new StringBuilder();
        if (printPrimary && params.getPrimary() != null) {
            String primary = format(params.getPrimary(), printInvisible);
            if (primary != null) {
                sb.append(primary);
            }
        }

        if (params.size() > 0) {
            sb.append("《");
            boolean first = true;
            for (Entry> entry : params.entrySet()) {

                // TOP and BOTTOM of QualParams hierarchy will have null avlues
                String value = "";
                if (entry.getValue() != null) {
                    value = format(entry.getValue(), printInvisible);
                    if (value == null) {
                        value = "";
                    }
                }

                if (first) {
                    first = false;
                } else {
                    sb.append(", ");
                }
                sb.append(entry.getKey());
                sb.append("=");

                sb.append(value);
            }
            sb.append("》");
        }

        if (sb.length() > 0) {
            return sb.toString();
        } else {
            return null;
        }
    }

    @Override
    public String format(PolyQual polyQual, boolean printInvisible) {

        if (polyQual == null) {
            return null;

        } else if (polyQual instanceof Combined) {
            Combined combined = (Combined) polyQual;

            // See if any of the vars should be printed
            List formattedVars = new ArrayList<>();
            for (QualVar var : combined.getVars()) {
                String formatted = format(var, printInvisible);
                if (formatted != null) {
                    formattedVars.add(formatted);
                }
            }
            String formatted = formatQual(combined.getGround(), printInvisible);
            if (formatted != null) {
                formattedVars.add(formatted);
            }
            if (formattedVars.size() == 0) {
                return null;
            }

            StringBuilder sb = new StringBuilder();
            sb.append(combined.getOp());
            sb.append("(");

            boolean first = true;
            for (String formattedVar : formattedVars) {
                if (first) {
                    first = false;
                } else {
                    sb.append(", ");
                }
                sb.append(formattedVar);
            }

            sb.append(")");
            return sb.toString();

        } else if (polyQual instanceof GroundQual) {
            return formatQual(((GroundQual) polyQual).getQualifier(), printInvisible);

        } else if (polyQual instanceof QualVar) {
            QualVar qualVar = (QualVar) polyQual;

            String lower = formatQual(qualVar.getLowerBound(), printInvisible);
            String upper = formatQual(qualVar.getUpperBound(), printInvisible);

            // The bounds have been suppressed, so don't create an output range.
            if (lower == null && upper == null) {
                return qualVar.getName();
            } else {
                lower = lower == null? "" : lower;
                upper = upper == null? "" : upper;
                return qualVar.getName()+ " ∈ [" + lower + ".." + upper + "])";
            }

        } else {
            ErrorReporter.errorAbort("Unknown PolyQual Subclass: " + polyQual);
            return ""; // Dead code
        }
    }

    private String format(Wildcard wildcard, boolean printInvisible) {
        if (wildcard.isEmpty()) {
            return "ø";

        } else if (wildcard.getLowerBound().equals(wildcard.getUpperBound())) {
            return format(wildcard.getLowerBound(), printInvisible);

        } else {
            String upper = format(wildcard.getUpperBound(), printInvisible);
            String lower = format(wildcard.getLowerBound(), printInvisible);
            if (upper == null && lower == null) {
                return "?";
            } else {
                lower = lower == null? "" : lower;
                upper = upper == null? "" : upper;
                return "? ∈ [" + lower + ".." + upper + "]";
            }
        }
    }

    private String formatQual(Q qual, boolean printInvisible) {
        if (printInvisible || !invisibleQualifiers.contains(qual)) {
            return "@" + qual.toString();
        } else {
            return null;
        }
    }
}