org.aya.util.reporter.Reporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tools Show documentation

The Aya proof assistant

There is a newer version: 0.34.0

// Copyright (c) 2020-2022 Tesla (Yinsen) Zhang.
// Use of this source code is governed by the MIT license that can be found in the LICENSE.md file.
package org.aya.util.reporter;

import org.aya.pretty.doc.Doc;
import org.aya.pretty.error.PrettyError;
import org.aya.util.prettier.PrettierOptions;
import org.aya.util.error.SourcePos;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;

public interface Reporter {
  /**
   * Report a problem
   *
   * @param problem problem to report
   */
  void report(@NotNull Problem problem);

  @ApiStatus.Internal
  default void reportString(@NotNull String s) {
    reportString(s, Problem.Severity.INFO);
  }

  @ApiStatus.Internal
  default void reportString(@NotNull String s, Problem.Severity severity) {
    reportDoc(Doc.english(s), severity);
  }

  @ApiStatus.Internal
  default void reportNest(@NotNull String text, int indent) {
    reportNest(text, indent, Problem.Severity.INFO);
  }

  @ApiStatus.Internal
  default void reportNest(@NotNull String text, int indent, Problem.Severity severity) {
    reportDoc(Doc.nest(indent, Doc.english(text)), severity);
  }

  @ApiStatus.Internal
  default void reportDoc(@NotNull Doc doc, final Problem.Severity severity) {
    report(dummyProblem(doc, severity));
  }

  static @NotNull Problem dummyProblem(@NotNull Doc doc, Problem.Severity severity) {
    return new Problem() {
      @Override public @NotNull SourcePos sourcePos() {
        return SourcePos.NONE;
      }

      @Override public @NotNull Severity level() {
        return severity;
      }

      @Override public @NotNull Doc describe(@NotNull PrettierOptions options) {
        return doc;
      }
    };
  }

  static @NotNull String errorMessage(
    @NotNull Problem problem, @NotNull PrettierOptions options,
    boolean unicode, boolean supportAnsi, int pageWidth
  ) {
    var prettyErrorConf = unicode
      ? PrettyError.FormatConfig.UNICODE
      : PrettyError.FormatConfig.CLASSIC;
    var doc = problem.sourcePos() == SourcePos.NONE
      ? problem.describe(options)
      : problem.toPrettyError(options, prettyErrorConf).toDoc();
    return supportAnsi
      ? doc.renderToTerminal(pageWidth, unicode)
      : doc.renderToString(pageWidth, unicode);
  }
}