org.aya.util.error.SourceFileLocator 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-2023 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.error;

import kala.collection.SeqLike;
import kala.collection.immutable.ImmutableSeq;
import org.jetbrains.annotations.NotNull;

import java.nio.file.Path;

/** module path aware file name normalizer for error reporting. */
public interface SourceFileLocator {
  /**
   * Resolve absolute source file path to module-root.
   * for example, assuming we have a module root `/path/to/root`,
   * resolving the source file path `/path/to/root/A/B/C.aya`
   * should result in `A/B/C.aya`
   *
   * @param path Path to source file
   * @return relativized file path if it belongs to a module, otherwise the original path is returned
   */
  default @NotNull Path displayName(@NotNull Path path) { return path; }
  @NotNull SourceFileLocator EMPTY = new Module(ImmutableSeq.empty());

  record Module(@NotNull SeqLike modulePath) implements SourceFileLocator {
    @Override public @NotNull Path displayName(@NotNull Path path) {
      var normalized = path.toAbsolutePath().normalize();
      return modulePath.find(m -> normalized.startsWith(m.toAbsolutePath()))
        .getOrDefault(found -> found.toAbsolutePath().normalize().relativize(normalized), path);
    }
  }
}