001/*
002 * Copyright (C) 2022 - 2023, the original author or authors.
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 */
016package io.github.ascopes.jct.filemanagers.config;
017
018import io.github.ascopes.jct.compilers.JctCompiler;
019import io.github.ascopes.jct.filemanagers.JctFileManager;
020import io.github.ascopes.jct.utils.SpecialLocationUtils;
021import io.github.ascopes.jct.utils.StringUtils;
022import io.github.ascopes.jct.workspaces.impl.WrappingDirectoryImpl;
023import javax.tools.StandardLocation;
024import org.apiguardian.api.API;
025import org.apiguardian.api.API.Status;
026import org.slf4j.Logger;
027import org.slf4j.LoggerFactory;
028
029/**
030 * Configurer for a file manager that applies the running JVM's module path to the file manager.
031 *
032 * <p>If module path inheritance is disabled in the compiler, then this will not run.
033 *
034 * @author Ashley Scopes
035 * @since 0.0.1
036 */
037@API(since = "0.0.1", status = Status.STABLE)
038public final class JctFileManagerJvmModulePathConfigurer implements JctFileManagerConfigurer {
039
040  private static final Logger LOGGER = LoggerFactory
041      .getLogger(JctFileManagerJvmModulePathConfigurer.class);
042
043  private final JctCompiler compiler;
044
045  /**
046   * Initialise the configurer with the desired compiler.
047   *
048   * @param compiler the compiler to wrap.
049   */
050  public JctFileManagerJvmModulePathConfigurer(JctCompiler compiler) {
051    this.compiler = compiler;
052  }
053
054
055  @Override
056  public JctFileManager configure(JctFileManager fileManager) {
057    LOGGER.debug("Configuring module path");
058
059    SpecialLocationUtils
060        .currentModulePathLocations()
061        .stream()
062        .peek(loc -> LOGGER
063            .atTrace()
064            .setMessage("Adding {} ({}) to file manager module path (inherited from JVM))")
065            .addArgument(() -> StringUtils.quoted(loc.toAbsolutePath()))
066            .addArgument(() -> StringUtils.quoted(loc.toUri()))
067            .log())
068        .map(WrappingDirectoryImpl::new)
069        .forEach(dir -> {
070          // Since we do not know if the code being compiled will use modules or not just yet,
071          // make sure any modules are on the class path as well so that they remain accessible
072          // in unnamed modules.
073          fileManager.addPath(StandardLocation.MODULE_PATH, dir);
074          fileManager.addPath(StandardLocation.CLASS_PATH, dir);
075        });
076
077    return fileManager;
078  }
079
080  @Override
081  public boolean isEnabled() {
082    return compiler.isInheritModulePath();
083  }
084}