001    /*
002     * Copyright 2010-2015 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.kotlin.cli.common.messages;
018    
019    import kotlin.io.FilesKt;
020    import org.jetbrains.annotations.NotNull;
021    import org.jetbrains.annotations.Nullable;
022    import org.jetbrains.kotlin.utils.fileUtils.FileUtilsKt;
023    
024    import java.io.File;
025    
026    public interface MessageRenderer {
027    
028        MessageRenderer XML = new XmlMessageRenderer();
029    
030        MessageRenderer WITHOUT_PATHS = new PlainTextMessageRenderer() {
031            @Nullable
032            @Override
033            protected String getPath(@NotNull CompilerMessageLocation location) {
034                return null;
035            }
036        };
037    
038        MessageRenderer PLAIN_FULL_PATHS = new PlainTextMessageRenderer() {
039            @Nullable
040            @Override
041            protected String getPath(@NotNull CompilerMessageLocation location) {
042                return location.getPath();
043            }
044        };
045    
046        MessageRenderer PLAIN_RELATIVE_PATHS = new PlainTextMessageRenderer() {
047            @NotNull
048            private final File cwd = new File(".").getAbsoluteFile();
049    
050            @Nullable
051            @Override
052            protected String getPath(@NotNull CompilerMessageLocation location) {
053                String path = location.getPath();
054                return path == null ? path : FileUtilsKt.descendantRelativeTo(new File(path), cwd).getPath();
055            }
056        };
057    
058        String renderPreamble();
059    
060        String render(@NotNull CompilerMessageSeverity severity, @NotNull String message, @NotNull CompilerMessageLocation location);
061    
062        String renderConclusion();
063    }