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