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.IoPackage;
020    import org.jetbrains.annotations.NotNull;
021    import org.jetbrains.annotations.Nullable;
022    
023    import java.io.File;
024    
025    public interface MessageRenderer {
026    
027        MessageRenderer XML = new XmlMessageRenderer();
028    
029        MessageRenderer PLAIN_FULL_PATHS = new PlainTextMessageRenderer() {
030            @Nullable
031            @Override
032            protected String getPath(@NotNull CompilerMessageLocation location) {
033                return location.getPath();
034            }
035        };
036    
037        MessageRenderer PLAIN_RELATIVE_PATHS = new PlainTextMessageRenderer() {
038            private final File cwd = new File(".").getAbsoluteFile();
039    
040            @Nullable
041            @Override
042            protected String getPath(@NotNull CompilerMessageLocation location) {
043                String path = location.getPath();
044                return cwd == null || path == null ? path : IoPackage.relativePath(cwd, new File(path));
045            }
046        };
047    
048        String renderPreamble();
049    
050        String render(@NotNull CompilerMessageSeverity severity, @NotNull String message, @NotNull CompilerMessageLocation location);
051    
052        String renderConclusion();
053    }