com.palantir.javaformat.InputOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of palantir-java-format Show documentation
Palantir open source project
There is a newer version: 2.50.0
/*
 * Copyright 2015 Google Inc.
 *
 * 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.palantir.javaformat;

import com.google.common.collect.DiscreteDomain;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Range;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/** This interface defines methods common to an {@link Input} or an {@link Output}. */
public abstract class InputOutput {
    private ImmutableList lines = ImmutableList.of();

    protected static final Range EMPTY_RANGE = Range.closedOpen(-1, -1);
    private static final DiscreteDomain INTEGERS = DiscreteDomain.integers();

    /** Set the lines. */
    protected final void setLines(ImmutableList lines) {
        this.lines = lines;
    }

    /**
     * Get the line count.
     *
     * @return the line count
     */
    public final int getLineCount() {
        return lines.size();
    }

    /**
     * Get a line.
     *
     * @param lineI the line number
     * @return the line
     */
    public final String getLine(int lineI) {
        return lines.get(lineI);
    }

    /** The {@link Range}s of the tokens or comments lying on each line, in any part. */
    protected final List> ranges = new ArrayList<>();

    private static void addToRanges(List> ranges, int i, int k) {
        while (ranges.size() <= i) {
            ranges.add(EMPTY_RANGE);
        }
        Range oldValue = ranges.get(i);
        ranges.set(i, Range.closedOpen(oldValue.isEmpty() ? k : oldValue.lowerEndpoint(), k + 1));
    }

    protected final void computeRanges(List toks) {
        int lineI = 0;
        for (Input.Tok tok : toks) {
            String txt = tok.getOriginalText();
            int lineI0 = lineI;
            lineI += Newlines.count(txt);
            int k = tok.getIndex();
            if (k >= 0) {
                for (int i = lineI0; i <= lineI; i++) {
                    addToRanges(ranges, i, k);
                }
            }
        }
    }

    /**
     * Given an {@code InputOutput}, compute the map from tok indices to line ranges.
     *
     * @param put the {@code InputOutput}
     * @return the map from {@code com.google.googlejavaformat.java.JavaInput.Tok} indices to line ranges in this
     *     {@code put}
     */
    public static Map> makeKToIJ(InputOutput put) {
        Map> map = new HashMap<>();
        int ijN = put.getLineCount();
        for (int ij = 0; ij <= ijN; ij++) {
            Range range = put.getRanges(ij).canonical(INTEGERS);
            for (int k = range.lowerEndpoint(); k < range.upperEndpoint(); k++) {
                if (map.containsKey(k)) {
                    map.put(k, Range.closedOpen(map.get(k).lowerEndpoint(), ij + 1));
                } else {
                    map.put(k, Range.closedOpen(ij, ij + 1));
                }
            }
        }
        return map;
    }

    /**
     * Get the {@link Range} of {@link Input.Tok}s lying in any part on a line.
     *
     * @param lineI the line number
     * @return the {@link Range} of {@link Input.Tok}s on the specified line
     */
    public final Range getRanges(int lineI) {
        return 0 <= lineI && lineI < ranges.size() ? ranges.get(lineI) : EMPTY_RANGE;
    }

    @Override
    public String toString() {
        return "InputOutput{" + "lines=" + lines + ", ranges=" + ranges + '}';
    }
}