com.android.ide.common.blame.parser.ToolOutputParser Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 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.ide.common.blame.parser;

import com.android.annotations.NonNull;
import com.android.ide.common.blame.Message;
import com.android.ide.common.blame.SourceFilePosition;
import com.android.ide.common.blame.parser.util.OutputLineReader;
import com.android.utils.ILogger;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;

import java.util.Collections;
import java.util.List;

public class ToolOutputParser {

    @NonNull
    private final List mParsers;

    @NonNull
    private final ILogger mLogger;

    @NonNull
    private final Message.Kind mUnparsedMessageKind;

    public ToolOutputParser(@NonNull Iterable parsers, @NonNull ILogger logger) {
        this(ImmutableList.copyOf(parsers), Message.Kind.SIMPLE, logger);
    }

    public ToolOutputParser(@NonNull PatternAwareOutputParser [] parsers, @NonNull ILogger logger) {
        this(ImmutableList.copyOf(parsers), Message.Kind.SIMPLE, logger);
    }

    public ToolOutputParser(@NonNull PatternAwareOutputParser parser, @NonNull ILogger logger) {
        this(ImmutableList.of(parser), Message.Kind.SIMPLE, logger);
    }

    public ToolOutputParser(@NonNull PatternAwareOutputParser parser,
            @NonNull Message.Kind unparsedMessageKind, @NonNull ILogger logger) {
        this(ImmutableList.of(parser), unparsedMessageKind, logger);
    }

    private ToolOutputParser(@NonNull ImmutableList parsers,
            @NonNull Message.Kind unparsedMessageKind,
            @NonNull ILogger logger) {
        mParsers = parsers;
        mUnparsedMessageKind = unparsedMessageKind;
        mLogger = logger;
    }

    public List parseToolOutput(@NonNull String output) {
        return parseToolOutput(output, false);
    }

    public List parseToolOutput(@NonNull String output, boolean ignoreUnrecognizedText) {
        OutputLineReader outputReader = new OutputLineReader(output);

        if (outputReader.getLineCount() == 0) {
            return Collections.emptyList();
        }

        List messages = Lists.newArrayList();
        String line;
        while ((line = outputReader.readLine()) != null) {
            if (line.trim().isEmpty()) {
                continue;
            }
            boolean handled = false;
            for (PatternAwareOutputParser parser : mParsers) {
                try {
                    if (parser.parse(line, outputReader, messages, mLogger)) {
                        handled = true;
                        break;
                    }
                }
                catch (ParsingFailedException e) {
                    return Collections.emptyList();
                }
            }
            if (handled) {
                int messageCount = messages.size();
                if (messageCount > 0) {
                    Message last = messages.get(messageCount - 1);
                    if (last.getText().contains("Build cancelled")) {
                        // Build was cancelled, just quit. Extra messages are just confusing noise.
                        break;
                    }
                }
            }
            else if (!ignoreUnrecognizedText) {
                // If none of the standard parsers recognize the input, include it as info such
                // that users don't miss potentially vital output such as gradle plugin exceptions.
                // If there is predictable useless input we don't want to appear here, add a custom
                // parser to digest it.
                messages.add(new Message(mUnparsedMessageKind, line, SourceFilePosition.UNKNOWN));
            }
        }
        return messages;
    }
}