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